OMKAwarenessAnimator.cpp

Go to the documentation of this file.

/************************************************************************/
/* This file is part of openMask(c) INRIA, CNRS, Universite de Rennes 1 */
/* 1993-00, 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 "OMKAwarenessAnimator.h"

#include "OMKOgreVis.h"
#include "OMKOgreObject.h"
#include "OgreMovableObject.h"
#include "OMKParametersAccessor.inl"
#include "OMKTracer.h"
#include "OMKColor.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;

//=========================================================================
// AwarenessAnimator
//=========================================================================

//-------------------------------------------------------------------------
// registration for both:  string and bool
//-------------------------------------------------------------------------
REGISTER_TEMPLATE_ANIMATOR_FACTORY( AwarenessAnimator< OMK::Type::StringType >, "AwarenessAnimator" ) ;
REGISTER_TEMPLATE_ANIMATOR_FACTORY( AwarenessAnimator< OMK::Type::BoolType >, "AwarenessBoolAnimator" ) ;

//-------------------------------------------------------------------------
// constructor
//-------------------------------------------------------------------------
template< typename Type >
AwarenessAnimator< Type >::AwarenessAnimator( VisualObject& visualObject,
                                              const Name& id,
                                              const ConfigurationParameterDescriptor& node )
: OgreAnimatorT< Type >( visualObject, id, node ),
  IUpdateMaterial(),
  _node( 0 ),
  _awareness( false ),
  _color( 1.0f, 1.0f, 0.0f, 0.6f )//Yellow
{
  Ogre::SceneNode* sceneNode = dynamic_cast< Ogre::SceneNode *>( &this->getNode() ) ;
  OMASSERTM( sceneNode, "No scene node found !" ) ;
  OgreObject* ogreObject = dynamic_cast< OgreObject* >( &this->getVisualObject() ) ;
  OMASSERTM( ogreObject, "The visual object must be a OgreObject" ) ;
  _node = ogreObject->getNodeMaterialOrig()->find( sceneNode ) ;

  OMK::Type::Color colorTmp( _color.x, _color.y, _color.z, _color.w ) ;
  if ( ParametersAccessor::get( &node, "AwarenessColor", colorTmp ) )
  {
    _color = Ogre::Vector4( colorTmp[0], colorTmp[1], colorTmp[2], colorTmp[3] );
  }
  else
  {
    OMMESSAGE( "Default Yellow Parameters for the AwarenessColor" );
  }
}

//-------------------------------------------------------------------------
// destructor
//-------------------------------------------------------------------------
template< typename Type >
AwarenessAnimator< Type >::~AwarenessAnimator()
{
}

//-------------------------------------------------------------------------
// doIt
//-------------------------------------------------------------------------
template< typename Type >
void AwarenessAnimator< Type >::doIt( bool awareness ) 
{
  if( awareness != _awareness )
  {
    _awareness = awareness ;
    if( _awareness )
    {
      _node->createCopyAndUpdateWith( this ) ;
    }
    else
    {
      _node->undoFor( this, true ) ;
    }
  }
}

//-------------------------------------------------------------------------
// update
//-------------------------------------------------------------------------
template< typename Type >
void AwarenessAnimator< Type >::update( NodeMaterial* node ) 
{
  OMASSERTM( _awareness, "The awareness should be set to true" ) ;
  node->doAction( MaterialSetAwareness( _color ) ) ;
}

//-------------------------------------------------------------------------
// getMaterialName
//-------------------------------------------------------------------------
template< typename Type >
Ogre::String AwarenessAnimator< Type >::getMaterialName( const Ogre::String& name ) const 
{ 
  return getUniqueMaterialName(name + "_Awareness" + ( _awareness ? "1" : "0" )) ;
}
//-------------------------------------------------------------------------
// Specific instanciations of selfProcessVis
//-------------------------------------------------------------------------
namespace OMK
{
namespace Vis
{
// selfProcessVis for string
template<>
void AwarenessAnimator< OMK::Type::StringType >::selfProcessVis( const OMK::Type::StringType& value )
{

  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 ) ;
}
// selfProcessVis for bool
template<>
void AwarenessAnimator< OMK::Type::BoolType >::selfProcessVis( const OMK::Type::BoolType& value )
{
  doIt( value.getValue() ) ;
}
} //namespace OMK
} //namespace Vis
//-------------------------------------------------------------------------


//=========================================================================
// AwarenessColorAnimator
//=========================================================================

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

//-------------------------------------------------------------------------
// constructor
//-------------------------------------------------------------------------
AwarenessColorAnimator::AwarenessColorAnimator( VisualObject& visualObject,
                                      const Name& id,
                                      const ConfigurationParameterDescriptor& node )
: OgreAnimatorT< OMK::Type::ColorType >( visualObject, id, node ),
  IUpdateMaterial(),
  _node( 0 ),
  _awareness( false ),
  _color( 1.0f, 1.0f, 0.0f, 0.6f )//default Yellow
{
  Ogre::SceneNode* sceneNode = dynamic_cast< Ogre::SceneNode *>( &getNode() ) ;
  OMASSERTM( sceneNode, "No scene node found !" ) ;
  OgreObject* ogreObject = dynamic_cast< OgreObject* >( &visualObject ) ;
  OMASSERTM( ogreObject, "The visual object must be a OgreObject" ) ;
  _node = ogreObject->getNodeMaterialOrig()->find( sceneNode ) ;
}

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

//-------------------------------------------------------------------------
// selfProcessVis
//-------------------------------------------------------------------------
void AwarenessColorAnimator::selfProcessVis( const OMK::Type::ColorType& value )
{

  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 ) ;
    }
  }
}

//-------------------------------------------------------------------------
// update
//-------------------------------------------------------------------------
void AwarenessColorAnimator::update( NodeMaterial* node ) 
{
  OMASSERTM( _awareness, "The awareness should be set to true" ) ;
  node->doAction( MaterialSetAwareness( _color ) ) ;
}

//-------------------------------------------------------------------------
// getMaterialName
//-------------------------------------------------------------------------
Ogre::String AwarenessColorAnimator::getMaterialName( const Ogre::String& name ) const 
{ 
  return getUniqueMaterialName( name + "_Awareness" + ( _awareness ? "1" : "0" ) ) ;
}

---