OMK::Vis::AwarenessColorAnimator Class Reference
[Animators]

Awareness animator to change the highlight color of a object. More...

#include <OMKAwarenessAnimator.h>

Inheritance diagram for OMK::Vis::AwarenessColorAnimator:

[legend]Collaboration diagram for OMK::Vis::AwarenessColorAnimator:

[legend]List of all members.

Protected Member Functions
virtual void	update (NodeMaterial *node)
virtual Ogre::String	getMaterialName (const Ogre::String &name) const
Protected Attributes
NodeMaterialOrig *	_node
	pointer to the node to animate
bool	_awareness
Ogre::Vector4	_color
Private Member Functions
	DECLARE_ANIMATOR_FACTORY (AwarenessColorAnimator)
virtual void	selfProcessVis (const OMK::Type::ColorType &value)
	Called by the partner to process the visualisation.

---

Detailed Description

Awareness animator to change the highlight color of a object.

Author:

Benoît Chanclou, bunraku <bchanclo@irisa.fr>

Configuration parameters :

The configuration parameters are those of any animator.

Animator
{
myAwarenessAnimator
{
  Class AwarenessAnimator
  NodeName Robot
  ListenedEvent "awareness"
}

The animator uses a color to update the awareness color. To remove the awareness, the color sent must have a null alpha channel.

Example:

visuOgre
{
  Class OgreVis
  ...
  Extensions
  {
    ...
    awarenessWithColor
    {
      Class KeyColorEmitterExtension
      Key A
      VisuName visuOgre 
      EventName "awarenessWithColor"
      Values [[1.0 0.0 0.0] [0.0 1.0 0.0] [0.0 0.0 1.0] [0.0 0.0 0.0 0.0]] // red, blue, green, none
      Signal on
    }        
    ...
  }
  UserParams
  {
    OgreHome "${OGRE_HOME}"
    ...
    VisualObject
    {
      ...
      scene
      {
        Class OgreObjectScene
        ...
        Animator
        {
          awarenessWithColor
          {
            Class AwarenessColorAnimator
            NodeName NODE
            ListenedEvent "awarenessWithColor"
          }
        }
      }
      ...
    }
  }
}

Definition at line 223 of file OMKAwarenessAnimator.h.

---

Member Function Documentation

OMK::Vis::AwarenessColorAnimator::DECLARE_ANIMATOR_FACTORY

(

AwarenessColorAnimator

)

[private]

void AwarenessColorAnimator::selfProcessVis

(

const OMK::Type::ColorType &

value

)

[private, virtual]

Called by the partner to process the visualisation.

Called by the public version if the value was changed. Must be overwrite by sons.

Definition at line 201 of file OMKAwarenessAnimator.cpp.

References _awareness, _color, _node, OMK::Vis::NodeMaterialOrig::createCopyAndUpdateWith(), OMK::Type::SimpleTypeT< T >::getValue(), OMTRACEID, and OMK::Vis::NodeMaterialOrig::undoFor().

{

  OMTRACEID("OMK::AwarenessAnimator"," got " << value );
  //ON/OFF now
  Ogre::Vector4 newColor( value.getValue()[0], value.getValue()[1], value.getValue()[2], value.getValue()[3] );
  bool newAwareness = 0.0f != value.getValue()[3] ;
  if( ( _awareness != newAwareness ) || ( newColor != _color ) )
  {
    _color = newColor ;
    if( _awareness && newAwareness )
    {
      _node->undoFor( this, false ) ;
    }
    else if( !_awareness && newAwareness )
    {
      _awareness = true ;
      _node->createCopyAndUpdateWith( this ) ;
    }
    else if( _awareness && !newAwareness )
    {
      _awareness = false ;
      _node->undoFor( this, true ) ;
    }
  }
}

void AwarenessColorAnimator::update

(

NodeMaterial *

node

)

[protected, virtual]

Implements OMK::Vis::IUpdateMaterial.

Definition at line 231 of file OMKAwarenessAnimator.cpp.

References _awareness, _color, OMK::Vis::NodeMaterial::doAction(), and OMASSERTM.

{
  OMASSERTM( _awareness, "The awareness should be set to true" ) ;
  node->doAction( MaterialSetAwareness( _color ) ) ;
}

Ogre::String AwarenessColorAnimator::getMaterialName

(

const Ogre::String &

name

)

const [protected, virtual]

Reimplemented from OMK::Vis::IUpdateMaterial.

Definition at line 240 of file OMKAwarenessAnimator.cpp.

References _awareness, and OMK::Vis::IUpdateMaterial::getUniqueMaterialName().

{ 
  return getUniqueMaterialName( name + "_Awareness" + ( _awareness ? "1" : "0" ) ) ;
}

---

Member Data Documentation

NodeMaterialOrig* OMK::Vis::AwarenessColorAnimator::_node [protected]

pointer to the node to animate

Reimplemented from OMK::Vis::OgreAnimatorCommon.

Definition at line 236 of file OMKAwarenessAnimator.h.

Referenced by selfProcessVis().

bool OMK::Vis::AwarenessColorAnimator::_awareness [protected]

Definition at line 237 of file OMKAwarenessAnimator.h.

Referenced by getMaterialName(), selfProcessVis(), and update().

Ogre::Vector4 OMK::Vis::AwarenessColorAnimator::_color [protected]

Definition at line 238 of file OMKAwarenessAnimator.h.

Referenced by selfProcessVis(), and update().

---