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

Animator to animate the transparency of an object. More...

#include <OMKTransparencyAnimator.h>

Inheritance diagram for OMK::Vis::TransparencyValueAnimator:

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

[legend]List of all members.

Protected Member Functions
virtual void	update (NodeMaterial *node)
virtual Ogre::String	getMaterialName (const Ogre::String &name) const
Protected Attributes
float	_transparency
NodeMaterialOrig *	_node
	pointer to the node to animate
Private Member Functions
	DECLARE_ANIMATOR_FACTORY (TransparencyValueAnimator)
virtual void	selfProcessVis (const OMK::Type::FloatType &value)
	Called by the partner to process the visualisation.

---

Detailed Description

Animator to animate the transparency of an object.

Author:

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

The floating value defines the object transparency (0.0 no transparency, 1.0 full transparency).

Configuration parameters :

The configuration parameters are those of any animator

  Animator
  {
      myTransparencyAnimator
      {
        Class TransparencyBoolAnimator
        NodeName Robot
      }
  } 

Definition at line 134 of file OMKTransparencyAnimator.h.

---

Member Function Documentation

OMK::Vis::TransparencyValueAnimator::DECLARE_ANIMATOR_FACTORY

(

TransparencyValueAnimator

)

[private]

void TransparencyValueAnimator::selfProcessVis

(

const OMK::Type::FloatType &

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 209 of file OMKTransparencyAnimator.cpp.

References _node, _transparency, OMK::Vis::NodeMaterialOrig::createCopyAndUpdateWith(), OMK::Vis::NodeMaterialOrig::find(), OMK::Vis::OgreAnimatorCommon::getNode(), OMK::Vis::OgreObject::getNodeMaterialOrig(), OMK::Type::SimpleTypeT< T >::getValue(), OMK::Vis::Animator::getVisualObject(), OMASSERTM, and OMK::Vis::NodeMaterialOrig::undoFor().

{
  if (!_node)
  {
    Ogre::SceneNode* sceneNode = dynamic_cast< Ogre::SceneNode *>( &getNode() ) ;
    OMASSERTM( sceneNode, "No scene node found !" ) ;
    OgreObject* ogreObject = dynamic_cast< OgreObject* >( &getVisualObject() ) ;
    OMASSERTM( ogreObject, "The visual object must be a OgreObject" ) ;
    _node = ogreObject->getNodeMaterialOrig()->find( sceneNode ) ;
  }
  if( _transparency != value.getValue() )
  {
    if( 1.0f ==_transparency )
    {
      _transparency = value.getValue() ;
      _node->createCopyAndUpdateWith( this ) ;
    }
    else if( 1.0f == value.getValue() )
    {
      _transparency = value.getValue() ;
      _node->undoFor( this, true ) ;
    }
    else
    {
      _transparency = value.getValue() ;
      _node->undoFor( this, false ) ;
    }
  }
}

void TransparencyValueAnimator::update

(

NodeMaterial *

node

)

[protected, virtual]

Implements OMK::Vis::IUpdateMaterial.

Definition at line 242 of file OMKTransparencyAnimator.cpp.

References _transparency, and OMK::Vis::NodeMaterial::doAction().

{
  node->doAction( MaterialSetSceneBlending( Ogre::SBT_TRANSPARENT_ALPHA ) ) ;
  node->doAction( MaterialSetTransparency( _transparency ) ) ;
}

Ogre::String TransparencyValueAnimator::getMaterialName

(

const Ogre::String &

name

)

const [protected, virtual]

Reimplemented from OMK::Vis::IUpdateMaterial.

Definition at line 251 of file OMKTransparencyAnimator.cpp.

References OMK::Vis::IUpdateMaterial::getUniqueMaterialName().

{ 
  return  getUniqueMaterialName( name + "_Transparency" ) ;
}

---

Member Data Documentation

float OMK::Vis::TransparencyValueAnimator::_transparency [protected]

Definition at line 147 of file OMKTransparencyAnimator.h.

Referenced by selfProcessVis(), and update().

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

pointer to the node to animate

Reimplemented from OMK::Vis::OgreAnimatorCommon.

Definition at line 148 of file OMKTransparencyAnimator.h.

Referenced by selfProcessVis().

---