OMKTransparencyAnimator.cpp

Go to the documentation of this file.

/************************************************************************/
/* This file is part of openMask(c) INRIA, CNRS, Universite de Rennes 1 */
/* 1993-2002, thereinafter the Software                                 */
/*                                                                      */
/* The Software has been developped within the Siames Project.          */
/* INRIA, the University of Rennes 1 and CNRS jointly hold intellectual */
/* property rights                                                      */
/*                                                                      */
/* The Software has been registered with the Agence pour la Protection  */
/* des Programmes (APP) under registration number                       */
/* IDDN.FR.001.510008.00.S.P.2001.000.41200                             */
/*                                                                      */
/* This file may be distributed under the terms of the Q Public License */
/* version 1.0 as defined by Trolltech AS of Norway and appearing in    */
/* the file LICENSE.QPL included in the packaging of this file.         */
/*                                                                      */
/* Licensees holding valid specific licenses issued by INRIA, CNRS or   */
/* Universite Rennes 1 for the software may use this file in            */
/* acordance with that specific license                                 */
/************************************************************************/
#include "OMKTransparencyAnimator.h"

#include "OMKOgreVis.h"
#include "OMKOgreObject.h"
#include "OgreMovableObject.h"
#include "OMKParametersAccessor.h"
#include "OMKEntityMaterialAction.h"

using namespace OMK ;
using namespace OMK::Vis ;
using namespace OMK::Type ;
using std::string;
using Ogre::SceneNode;
using Ogre::MovableObject;
using Ogre::Entity;


//=========================================================================
// TransparencyAnimAnimator
//=========================================================================

//-------------------------------------------------------------------------
// registration in factory
//-------------------------------------------------------------------------
REGISTER_ANIMATOR_FACTORY( TransparencyAnimAnimator, "TransparencyAnimator" ) ;

//-------------------------------------------------------------------------
// constructor
//-------------------------------------------------------------------------
TransparencyAnimAnimator::TransparencyAnimAnimator( VisualObject& visualObject, 
    const Name& id, 
    const ConfigurationParameterDescriptor& node ) 
: OgreAnimatorT< OMK::Type::StringType >( visualObject, id, node ),
  _transparency( 0.0f ),
  _node( 0 ) 
{
}

//-------------------------------------------------------------------------
// destructor
//-------------------------------------------------------------------------
TransparencyAnimAnimator::~TransparencyAnimAnimator()
{
}

//-------------------------------------------------------------------------
// selfProcessVis
//-------------------------------------------------------------------------
void TransparencyAnimAnimator::selfProcessVis( const OMK::Type::StringType& value ) 
{
  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 ) ;
    _node->createCopyAndUpdateWith( this ) ;
  }
  _transparency -= 0.1f ;  
  if( _transparency < 0.0f  )
    _transparency = 1.0f ; 
  _node->undoFor( this, false ) ;
}

//-------------------------------------------------------------------------
// update
//-------------------------------------------------------------------------
void TransparencyAnimAnimator::update( NodeMaterial* node ) 
{
  node->doAction( MaterialSetSceneBlending( Ogre::SBT_TRANSPARENT_ALPHA ) ) ;
  node->doAction( MaterialSetTransparency( _transparency ) ) ;
}

//-------------------------------------------------------------------------
// getMaterialName
//-------------------------------------------------------------------------
Ogre::String TransparencyAnimAnimator::getMaterialName( const Ogre::String& name ) const 
{ 
  return  getUniqueMaterialName( name + "_Transparency" ) ;
}


//=========================================================================
// TransparencyBoolAnimator
//=========================================================================

//-------------------------------------------------------------------------
// registration in factory
//-------------------------------------------------------------------------
REGISTER_ANIMATOR_FACTORY( TransparencyBoolAnimator, "TransparencyBoolAnimator" ) ;

//-------------------------------------------------------------------------
// constructor
//-------------------------------------------------------------------------
TransparencyBoolAnimator::TransparencyBoolAnimator( VisualObject& visualObject, 
    const Name& id, 
    const ConfigurationParameterDescriptor& nodeCfg ) 
: OgreAnimatorT< OMK::Type::BoolType >( visualObject, id, nodeCfg ),
  _transparency( 0.5f ),
  _state( false ),
  _node( 0 ) 
{
  ParametersAccessor::get( &nodeCfg, "Transparency", _transparency ) ;
}

//-------------------------------------------------------------------------
// destructor
//-------------------------------------------------------------------------
TransparencyBoolAnimator::~TransparencyBoolAnimator()
{
}

//-------------------------------------------------------------------------
// selfProcessVis
//-------------------------------------------------------------------------
void TransparencyBoolAnimator::selfProcessVis( const OMK::Type::BoolType& value ) 
{
  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( _state != value.getValue() )
  {
    _state = value.getValue() ;
    if( _state )
    {
      _node->createCopyAndUpdateWith( this ) ;
    }
    else
    {
      _node->undoFor( this, true ) ;
    }
  }
}

//-------------------------------------------------------------------------
// update
//-------------------------------------------------------------------------
void TransparencyBoolAnimator::update( NodeMaterial* node ) 
{
  node->doAction( MaterialSetSceneBlending( Ogre::SBT_TRANSPARENT_ALPHA ) ) ;
  node->doAction( MaterialSetTransparency( _transparency ) ) ;
}

//-------------------------------------------------------------------------
// getMaterialName
//-------------------------------------------------------------------------
Ogre::String TransparencyBoolAnimator::getMaterialName( const Ogre::String& name ) const 
{ 
  return  getUniqueMaterialName( name + "_Transparency" ) ;
}

//=========================================================================
// TransparencyValueAnimator
//=========================================================================

//-------------------------------------------------------------------------
// registration in factory
//-------------------------------------------------------------------------
REGISTER_ANIMATOR_FACTORY( TransparencyValueAnimator, "TransparencyValueAnimator" ) ;

//-------------------------------------------------------------------------
// constructor
//-------------------------------------------------------------------------
TransparencyValueAnimator::TransparencyValueAnimator( VisualObject& visualObject, 
    const Name& id, 
    const ConfigurationParameterDescriptor& node ) 
: OgreAnimatorT< OMK::Type::FloatType >( visualObject, id, node ),
  _transparency( 1.0f ),
  _node( 0 ) 
{
}

//-------------------------------------------------------------------------
// destructor
//-------------------------------------------------------------------------
TransparencyValueAnimator::~TransparencyValueAnimator()
{
}

//-------------------------------------------------------------------------
// selfProcessVis
//-------------------------------------------------------------------------
void TransparencyValueAnimator::selfProcessVis( const OMK::Type::FloatType& value ) 
{
  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 ) ;
    }
  }
}

//-------------------------------------------------------------------------
// update
//-------------------------------------------------------------------------
void TransparencyValueAnimator::update( NodeMaterial* node ) 
{
  node->doAction( MaterialSetSceneBlending( Ogre::SBT_TRANSPARENT_ALPHA ) ) ;
  node->doAction( MaterialSetTransparency( _transparency ) ) ;
}

//-------------------------------------------------------------------------
// getMaterialName
//-------------------------------------------------------------------------
Ogre::String TransparencyValueAnimator::getMaterialName( const Ogre::String& name ) const 
{ 
  return  getUniqueMaterialName( name + "_Transparency" ) ;
}

---