OMK::Vis::IAnimatorEventPlug Class Reference

The event plug interface to set an animator by event. More...

#include <OMKIAnimatorEventPlug.h>

Inheritance diagram for OMK::Vis::IAnimatorEventPlug:

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

[legend]List of all members.

Public Member Functions
Interface for \ref OMK::Vis::VisOgre.
virtual void	setEvent (const Event *event)
	Sets the associated value.
Protected Attributes
bool	_updatedValue
	Flag which show if the value is updated or not.
VisBase &	_vis
	Reference to the visualisation to remove the event plug when deleted.
EventIdentifier	_eventId
	Reference to the visualisation to remove the event plug when deleted.

---

Detailed Description

The event plug interface to set an animator by event.

Author:

Benoit Chanclou, bunraku <bchanclo@irisa.fr> This event plug is the interface used by visual object.

Definition at line 39 of file OMKIAnimatorEventPlug.h.

---

Constructor & Destructor Documentation

IAnimatorEventPlug::IAnimatorEventPlug	(	VisBase &	vis,
		const EventIdentifier &	eventId
	)

Default constructor.

Definition at line 35 of file OMKIAnimatorEventPlug.cpp.

: _updatedValue( false ), 
  _vis( vis ), 
  _eventId( eventId ) 
{
}

IAnimatorEventPlug::~IAnimatorEventPlug

(

)

[virtual]

Destructor.

Definition at line 45 of file OMKIAnimatorEventPlug.cpp.

References _eventId, _vis, and OMK::Vis::VisBase::removeEventPlug().

{
  _vis.removeEventPlug( _eventId, this ) ;
}

IAnimatorEventPlug::IAnimatorEventPlug	(	VisBase &	vis,
		const EventIdentifier &	eventId
	)

Default constructor.

Definition at line 35 of file OMKIAnimatorEventPlug.cpp.

: _updatedValue( false ), 
  _vis( vis ), 
  _eventId( eventId ) 
{
}

IAnimatorEventPlug::~IAnimatorEventPlug

(

)

[virtual]

Destructor.

Definition at line 45 of file OMKIAnimatorEventPlug.cpp.

References _eventId, _vis, and OMK::Vis::VisBase::removeEventPlug().

{
  _vis.removeEventPlug( _eventId, this ) ;
}

---

Member Function Documentation

virtual void OMK::Vis::IAnimatorEventPlug::setEvent

(

const Event *

event

)

[inline, virtual]

Sets the associated value.

Called by OMK::Vis::VisOgre to set the value when the event is recieved. Not a template, so no value is associated.

Reimplemented in OMK::Vis::AnimatorEventPlugT< T >.

Definition at line 58 of file OMKIAnimatorEventPlug.h.

  { 
          // A new value is coming
          _updatedValue = true ; 
  }

---

Member Data Documentation

bool OMK::Vis::IAnimatorEventPlug::_updatedValue [mutable, protected]

Flag which show if the value is updated or not.

This member variable is mutable because isValueChanged is a constant method.

Definition at line 71 of file OMKIAnimatorEventPlug.h.

Referenced by OMK::Vis::AnimatorEventPlugT< T >::isValueChanged(), OMK::Vis::AnimatorEventPlug::isValueChanged(), and OMK::Vis::AnimatorEventPlugT< T >::setEvent().

VisBase& OMK::Vis::IAnimatorEventPlug::_vis [protected]

Reference to the visualisation to remove the event plug when deleted.

Definition at line 73 of file OMKIAnimatorEventPlug.h.

Referenced by ~IAnimatorEventPlug().

EventIdentifier OMK::Vis::IAnimatorEventPlug::_eventId [protected]

Reference to the visualisation to remove the event plug when deleted.

Definition at line 75 of file OMKIAnimatorEventPlug.h.

Referenced by ~IAnimatorEventPlug().

---