OMK::Vis::AwarenessAnimator< Type > Class Template Reference
[Animators]

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

#include <OMKAwarenessAnimator.h>

Inheritance diagram for OMK::Vis::AwarenessAnimator< Type >:

[legend]Collaboration diagram for OMK::Vis::AwarenessAnimator< Type >:

[legend]List of all members.

Public Member Functions
template<>
void	selfProcessVis (const OMK::Type::StringType &value)
template<>
void	selfProcessVis (const OMK::Type::BoolType &value)
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_TEMPLATE_ANIMATOR_FACTORY (AwarenessAnimator, Type)
virtual void	selfProcessVis (const Type &value)
	Called by the partner to process the visualisation.
void	doIt (bool awareness)

---

Detailed Description

template<typename Type>
class OMK::Vis::AwarenessAnimator< Type >

Awareness animator to change the highlight color of a object.

Author:

Xavier Larrodé, bunraku <xlarrode@irisa.fr>

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

Configuration parameters :

The configuration parameters are those of any animator and:

• AwarenessColor color used to highlight the object.

//Note that example value is the default value...
Animator
{
myAwarenessAnimator
{
  Class AwarenessAnimator
  NodeName Robot
  ListenedEvent awareness
  AwarenessColor [1.0 1.0 0.0 0.6] // Optional, Yellow is the default Color
}

There are two types for the value to change the material.

The first type, MaterialBoolAnimator class, is a boolean:

• true put the material defines by material configuration parameter
• false reset the material to the initial material or the one defines by changeInitMaterial configuration parameter

The second type, MaterialAnimator class, is a string:

• "ON" is like true
• "OFF" is like false
• anything else toggles the state

Example:

visuOgre
{
  Class OgreVis
  ...
  Extensions
  {
    ...
    awarenessWithString
    {
      Class KeyStringEmitterExtension
      Key E
      VisuName visuOgre 
      EventName "awarenessWithString"
      Values ["TOGGLE"]
      Signal on
    }
    awarenessWithBool
    {
      Class KeyBoolEmitterExtension
      Key A
      VisuName visuOgre 
      EventName "awarenessWithBool"
      Values [ON OFF]
      Signal on
    }        
    ...
  }
  UserParams
  {
    OgreHome "${OGRE_HOME}"
    ...
    VisualObject
    {
      ...
      scene
      {
        Class OgreObjectScene
        ...
        Animator
        {
          awarenessWithString
          {
            Class AwarenessAnimator
            NodeName FirstNODE
            AwarenessColor [0.0 1.0 1.0 0.6]
            ListenedEvent "awarenessWithString"
          }
          awarenessWithBool
          {
            Class AwarenessBoolAnimator
            NodeName SecondNODE
            AwarenessColor [1.0 0.0 1.0 0.6]
            ListenedEvent "awarenessWithBool"
          }
        }
      }
      ...
    }
  }
}

Definition at line 135 of file OMKAwarenessAnimator.h.

---

Member Function Documentation

template<typename Type>

OMK::Vis::AwarenessAnimator< Type >::DECLARE_TEMPLATE_ANIMATOR_FACTORY	(	AwarenessAnimator< Type >	,
		Type
	)			[private]

template<typename Type>

virtual void OMK::Vis::AwarenessAnimator< Type >::selfProcessVis

(

const Type &

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.

Implements OMK::Vis::AnimatorT< Type >.

template<typename Type>

void AwarenessAnimator::doIt

(

bool

awareness

)

[private]

Definition at line 91 of file OMKAwarenessAnimator.cpp.

References OMK::Vis::AwarenessAnimator< Type >::_awareness, OMK::Vis::AwarenessAnimator< Type >::_node, OMK::Vis::NodeMaterialOrig::createCopyAndUpdateWith(), and OMK::Vis::NodeMaterialOrig::undoFor().

Referenced by OMK::Vis::AwarenessAnimator< Type >::selfProcessVis().

{
  if( awareness != _awareness )
  {
    _awareness = awareness ;
    if( _awareness )
    {
      _node->createCopyAndUpdateWith( this ) ;
    }
    else
    {
      _node->undoFor( this, true ) ;
    }
  }
}

template<typename Type>

void AwarenessAnimator::update

(

NodeMaterial *

node

)

[protected, virtual]

Implements OMK::Vis::IUpdateMaterial.

Definition at line 111 of file OMKAwarenessAnimator.cpp.

References OMK::Vis::AwarenessAnimator< Type >::_awareness, OMK::Vis::AwarenessAnimator< Type >::_color, OMK::Vis::NodeMaterial::doAction(), and OMASSERTM.

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

template<typename Type>

Ogre::String AwarenessAnimator::getMaterialName

(

const Ogre::String &

name

)

const [protected, virtual]

Reimplemented from OMK::Vis::IUpdateMaterial.

Definition at line 121 of file OMKAwarenessAnimator.cpp.

References OMK::Vis::AwarenessAnimator< Type >::_awareness, and OMK::Vis::IUpdateMaterial::getUniqueMaterialName().

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

template<>

void OMK::Vis::AwarenessAnimator< OMK::Type::StringType >::selfProcessVis

(

const OMK::Type::StringType &

value

)

Definition at line 134 of file OMKAwarenessAnimator.cpp.

References OMK::Vis::AwarenessAnimator< Type >::_awareness, OMK::Vis::AwarenessAnimator< Type >::doIt(), OMK::Type::SimpleTypeT< T >::getValue(), and OMTRACEID.

{

  OMTRACEID("OMK::AwarenessAnimator"," got " << value );
  //ON/OFF now
  std::string str( value.getValue() ) ;
  std::transform( str.begin(), str.end(), str.begin(), toupper ) ;
  bool newAwareness = !_awareness ;
  if( str == "ON" )
  {
    newAwareness = true ;
  }
  else if( str == "OFF" )
  {
    newAwareness = false ;
  }
  doIt( newAwareness ) ;
}

template<>

void OMK::Vis::AwarenessAnimator< OMK::Type::BoolType >::selfProcessVis

(

const OMK::Type::BoolType &

value

)

Definition at line 154 of file OMKAwarenessAnimator.cpp.

References OMK::Vis::AwarenessAnimator< Type >::doIt(), and OMK::Type::SimpleTypeT< T >::getValue().

{
  doIt( value.getValue() ) ;
}

---

Member Data Documentation

template<typename Type>

NodeMaterialOrig* OMK::Vis::AwarenessAnimator< Type >::_node [protected]

pointer to the node to animate

Reimplemented from OMK::Vis::OgreAnimatorCommon.

Definition at line 149 of file OMKAwarenessAnimator.h.

Referenced by OMK::Vis::AwarenessAnimator< Type >::doIt().

template<typename Type>

bool OMK::Vis::AwarenessAnimator< Type >::_awareness [protected]

Definition at line 150 of file OMKAwarenessAnimator.h.

Referenced by OMK::Vis::AwarenessAnimator< Type >::doIt(), OMK::Vis::AwarenessAnimator< Type >::getMaterialName(), OMK::Vis::AwarenessAnimator< Type >::selfProcessVis(), and OMK::Vis::AwarenessAnimator< Type >::update().

template<typename Type>

Ogre::Vector4 OMK::Vis::AwarenessAnimator< Type >::_color [protected]

Definition at line 151 of file OMKAwarenessAnimator.h.

Referenced by OMK::Vis::AwarenessAnimator< Type >::update().

---