OMK::Vis::OgreObject Class Reference

OgreObject creates a new scene node named with the id of this VisualObject and adds it into the subtree of root _sceneNode. More...

#include <OMKOgreObject.h>

Inheritance diagram for OMK::Vis::OgreObject:

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

[legend]List of all members.

Public Member Functions
NodeMaterialOrig *	getNodeMaterialOrig ()
	Return the node to change the materials.
const OgreVis &	getOgreVis () const
	returns a const reference to the associated visualisation
Ogre::SceneNode &	getSceneNode () const
	returns a const reference to the object root node
Protected Member Functions
virtual void	visualise ()
	implement the VisualObject visualise, do nothing
Protected Attributes
OgreVis &	_ogreVis
	reference to the associated visualisation
Ogre::SceneNode &	_sceneNode
	root node of the current geometry
NodeMaterialOrig *	_nodeMaterial
	MaterialAnimation stack.
Private Member Functions
	OgreObject (const OgreObject &vis)
	Copy constructor, private and not defined to prevent from copying.
const OgreObject &	operator= (const OgreObject &vis)
	Assigment operator, private and not defined to prevent from copying.

---

Detailed Description

OgreObject creates a new scene node named with the id of this VisualObject and adds it into the subtree of root _sceneNode.

Author:

Michaël Rouillé, bunraku <michael.rouille@irisa.fr>

Definition at line 42 of file OMKOgreObject.h.

---

Constructor & Destructor Documentation

OgreObject::OgreObject	(	VisBase &	vis,
		const Name &	id,
		const ConfigurationParameterDescriptor *	node
	)

Constructor of OMK::Vis::OgreObject.

Definition at line 35 of file OMKOgreObject.cpp.

References _sceneNode, OMK::Vis::convert(), and OMK::Vis::VisualObject::getTransform().

  : VisualObject( vis, id, node ),
    _ogreVis( static_cast< OgreVis& >( vis ) ),
    // create a new ogre scene node
    _sceneNode( *_ogreVis.touchRoot().getSceneManager( "sceneManager" )->getRootSceneNode()->createChildSceneNode( getId().getCString() ) ),
  _nodeMaterial( 0 )
{
  // converts the transform value read by VisualObject to the ogre node
  convert( getTransform(), _sceneNode ) ;
}

OgreObject::~OgreObject

(

)

[virtual]

Destructor of OMK::Vis::OgreObject.

Destroy the animators.

Definition at line 50 of file OMKOgreObject.cpp.

References OMK::Vis::VisualObject::_animators, _nodeMaterial, _ogreVis, _sceneNode, and OMK::Vis::OgreVis::touchRoot().

{
  //Animator Destruction before OgreStuff
  for( AnimatorsMap::iterator a( _animators.begin() ) ;
       a != _animators.end() ;
       a++ )
  {
    delete a->second ;
  }
  _animators.clear() ;
  _ogreVis.touchRoot().getSceneManager( "sceneManager" )->destroySceneNode( _sceneNode.getName() ) ;

  delete _nodeMaterial ;
}

OMK::Vis::OgreObject::OgreObject

(

const OgreObject &

vis

)

[private]

Copy constructor, private and not defined to prevent from copying.

OgreObject::OgreObject	(	VisBase &	vis,
		const Name &	id,
		const ConfigurationParameterDescriptor *	node
	)

Constructor of OMK::Vis::OgreObject.

Definition at line 35 of file OMKOgreObject.cpp.

References _sceneNode, OMK::Vis::convert(), and OMK::Vis::VisualObject::getTransform().

  : VisualObject( vis, id, node ),
    _ogreVis( static_cast< OgreVis& >( vis ) ),
    // create a new ogre scene node
    _sceneNode( *_ogreVis.touchRoot().getSceneManager( "sceneManager" )->getRootSceneNode()->createChildSceneNode( getId().getCString() ) ),
  _nodeMaterial( 0 )
{
  // converts the transform value read by VisualObject to the ogre node
  convert( getTransform(), _sceneNode ) ;
}

OgreObject::~OgreObject

(

)

[virtual]

Destructor of OMK::Vis::OgreObject.

Destroy the animators.

Definition at line 50 of file OMKOgreObject.cpp.

References OMK::Vis::VisualObject::_animators, _nodeMaterial, _ogreVis, _sceneNode, and OMK::Vis::OgreVis::touchRoot().

{
  //Animator Destruction before OgreStuff
  for( AnimatorsMap::iterator a( _animators.begin() ) ;
       a != _animators.end() ;
       a++ )
  {
    delete a->second ;
  }
  _animators.clear() ;
  _ogreVis.touchRoot().getSceneManager( "sceneManager" )->destroySceneNode( _sceneNode.getName() ) ;

  delete _nodeMaterial ;
}

---

Member Function Documentation

NodeMaterialOrig * OgreObject::getNodeMaterialOrig

(

)

Return the node to change the materials.

Definition at line 73 of file OMKOgreObject.cpp.

References _nodeMaterial, and _sceneNode.

Referenced by OMK::Vis::TransparencyValueAnimator::selfProcessVis(), and OMK::Vis::TransparencyAnimAnimator::selfProcessVis().

{
  if( !_nodeMaterial )
  {
    _nodeMaterial = new NodeMaterialOrig( &_sceneNode ) ;
  }
  return _nodeMaterial ;
}

const OgreVis & OMK::Vis::OgreObject::getOgreVis

(

)

const [inline]

returns a const reference to the associated visualisation

Definition at line 91 of file OMKOgreObject.h.

References _ogreVis.

{
  return _ogreVis ;
}

Ogre::SceneNode & OMK::Vis::OgreObject::getSceneNode

(

)

const [inline]

returns a const reference to the object root node

Definition at line 100 of file OMKOgreObject.h.

References _sceneNode.

{
  return _sceneNode ;
}

void OgreObject::visualise

(

)

[protected, virtual]

implement the VisualObject visualise, do nothing

Implements OMK::Vis::VisualObject.

Reimplemented in OMK::Vis::AvatarVisualObject.

Definition at line 69 of file OMKOgreObject.cpp.

{
}

const OgreObject& OMK::Vis::OgreObject::operator=

(

const OgreObject &

vis

)

[private]

Assigment operator, private and not defined to prevent from copying.

---

Member Data Documentation

OgreVis& OMK::Vis::OgreObject::_ogreVis [protected]

reference to the associated visualisation

Definition at line 79 of file OMKOgreObject.h.

Referenced by getOgreVis(), OMK::Vis::OgreObjectScene::loadGeometry(), and ~OgreObject().

Ogre::SceneNode& OMK::Vis::OgreObject::_sceneNode [protected]

root node of the current geometry

Definition at line 82 of file OMKOgreObject.h.

Referenced by getNodeMaterialOrig(), getSceneNode(), OMK::Vis::OgreObjectScene::loadGeometry(), OgreObject(), and ~OgreObject().

NodeMaterialOrig* OMK::Vis::OgreObject::_nodeMaterial [protected]

MaterialAnimation stack.

Definition at line 84 of file OMKOgreObject.h.

Referenced by getNodeMaterialOrig(), and ~OgreObject().

---