Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
om::engine::acoustics::SoundObjectTrajectory Class Reference

A class that handles the interaction of a sound object's trajectory with a generic trajectory. More...

#include <omEngineAcousticsConnections.h>

Inheritance diagram for om::engine::acoustics::SoundObjectTrajectory:
om::engine::base::Connector

Public Member Functions

 SoundObjectTrajectory ()
 Create a new sound object trajectory without an object or trajectory set. More...
 
virtual void read ()
 Read the object's trajectory from the connection. More...
 
virtual void write ()
 Write the object's trajectory to the connection. More...
 
virtual ConnectiongetConnection () const
 Return an opaque pointer to the connection that this connector is a part of. More...
 
virtual void * getObject () const
 Return an opaque pointer to the object that is connected to this connector. More...
 
virtual const ResourceType & getObjectType () const
 Return the resource type of the object that the connector is connected to. More...
 
virtual const ResourceType & getType () const
 Return the resource type of this connector's concrete subclass type. More...
 
- Public Member Functions inherited from om::engine::base::Connector
 Connector ()
 Create a new connector with the default state. More...
 
virtual ~Connector ()
 Destroy this connector and release all internal resources. More...
 
ConnectorFlagsgetFlags ()
 Return a reference to an object that contains boolean parameters of the connector. More...
 
const ConnectorFlagsgetFlags () const
 Return an object that contains boolean parameters of the connector. More...
 
void setFlags (const ConnectorFlags &newFlags)
 Set an object that contains boolean parameters of the connector. More...
 
Bool flagIsSet (ConnectorFlags::Flag flag) const
 Return whether or not the specified boolan flag is set for this connector. More...
 
Bool flagsAreSet (const ConnectorFlags &otherFlags) const
 Return whether or not all of the specified boolan flags are set for this connector. More...
 
void setFlag (ConnectorFlags::Flag flag, Bool newIsSet=true)
 Set whether or not the specified boolan flag is set for this connector. More...
 
Bool isDisabled () const
 Return whether or not this connector is currently disabled. More...
 
Bool getIsEnabled () const
 Return whether or not this connector is currently enabled. More...
 
void setIsEnabled (Bool newIsEnabled)
 Set whether or not this connector should be enabled. More...
 
const SystemTypegetSystemType () const
 Return an enum indicating the system type that determines when this connector should update. More...
 
void setSystemType (const SystemType &newSystemType)
 Set an enum indicating the system type that determines when this connector should update. More...
 

Public Attributes

SoundObject * object
 A pointer to the object that is using the trajectory. More...
 
TrajectoryConnectionconnection
 A pointer to the trajectory connection that the sound object is using. More...
 

Static Public Attributes

static const ResourceType RESOURCE_TYPE
 The resource type for a sound object trajectory. More...
 

Detailed Description

A class that handles the interaction of a sound object's trajectory with a generic trajectory.

Constructor & Destructor Documentation

om::engine::acoustics::SoundObjectTrajectory::SoundObjectTrajectory ( )
inline

Create a new sound object trajectory without an object or trajectory set.

Member Function Documentation

virtual void om::engine::acoustics::SoundObjectTrajectory::read ( )
virtual

Read the object's trajectory from the connection.

Implements om::engine::base::Connector.

virtual void om::engine::acoustics::SoundObjectTrajectory::write ( )
virtual

Write the object's trajectory to the connection.

Implements om::engine::base::Connector.

virtual Connection* om::engine::acoustics::SoundObjectTrajectory::getConnection ( ) const
virtual

Return an opaque pointer to the connection that this connector is a part of.

Implements om::engine::base::Connector.

virtual void* om::engine::acoustics::SoundObjectTrajectory::getObject ( ) const
virtual

Return an opaque pointer to the object that is connected to this connector.

Reimplemented from om::engine::base::Connector.

virtual const ResourceType& om::engine::acoustics::SoundObjectTrajectory::getObjectType ( ) const
virtual

Return the resource type of the object that the connector is connected to.

Reimplemented from om::engine::base::Connector.

virtual const ResourceType& om::engine::acoustics::SoundObjectTrajectory::getType ( ) const
virtual

Return the resource type of this connector's concrete subclass type.

Implements om::engine::base::Connector.

Member Data Documentation

SoundObject* om::engine::acoustics::SoundObjectTrajectory::object

A pointer to the object that is using the trajectory.

TrajectoryConnection* om::engine::acoustics::SoundObjectTrajectory::connection

A pointer to the trajectory connection that the sound object is using.

const ResourceType om::engine::acoustics::SoundObjectTrajectory::RESOURCE_TYPE
static

The resource type for a sound object trajectory.


The documentation for this class was generated from the following file: