An interface for connectors that interface between arbitrary object types and known connector types. More...

#include <omEngineConnector.h>

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

Public Member Functions
	Connector ()
	Create a new connector with the default state. More...

virtual	~Connector ()
	Destroy this connector and release all internal resources. More...

virtual void	read ()=0
	Read the data that is stored in the connector subclass and write it to the object. More...

virtual void	write ()=0
	Write the object's data to the data in the Connection subclass. More...

virtual Connection *	getConnection () const =0
	Return an opaque pointer to the connector 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 =0
	Return the resource type of this connector's concrete subclass type. More...

ConnectorFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the connector. More...

const ConnectorFlags &	getFlags () 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 SystemType &	getSystemType () 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...

Detailed Description

An interface for connectors that interface between arbitrary object types and known connector types.

The connector's purpose is to hide the identity of the object so that the number of connector types can be manageable. Otherwise there would be an O(N^2) number of connector types that would be needed. With this design the overhead is O(N) types, where N is the number of possible connectors.

Constructor & Destructor Documentation

om::engine::base::Connector::Connector ( )

inline

Create a new connector with the default state.

virtual om::engine::base::Connector::~Connector ( )

inlinevirtual

Destroy this connector and release all internal resources.

Member Function Documentation

virtual void om::engine::base::Connector::read ( )

pure virtual

Read the data that is stored in the connector subclass and write it to the object.

Implemented in om::engine::graphics::BoneTensor, om::engine::acoustics::SoundSourceTensor, om::engine::graphics::BoneTrajectory, om::engine::acoustics::SoundSourceTrajectory, om::engine::graphics::CameraTensor, om::engine::acoustics::SoundListenerTensor, om::engine::graphics::CameraTrajectory, om::engine::acoustics::SoundListenerTrajectory, om::engine::acoustics::SoundObjectTensor, om::engine::graphics::GraphicsObjectTensor, om::engine::physics::RigidObjectTensor, om::engine::acoustics::SoundObjectTrajectory, om::engine::graphics::GraphicsObjectTrajectory, om::engine::physics::RigidObjectTrajectory, and om::engine::animation::AnimationSequencerTrackTensor.

virtual void om::engine::base::Connector::write ( )

pure virtual

Write the object's data to the data in the Connection subclass.

Implemented in om::engine::graphics::BoneTensor, om::engine::acoustics::SoundSourceTensor, om::engine::graphics::BoneTrajectory, om::engine::acoustics::SoundSourceTrajectory, om::engine::graphics::CameraTensor, om::engine::acoustics::SoundListenerTensor, om::engine::graphics::CameraTrajectory, om::engine::acoustics::SoundListenerTrajectory, om::engine::acoustics::SoundObjectTensor, om::engine::graphics::GraphicsObjectTensor, om::engine::physics::RigidObjectTensor, om::engine::acoustics::SoundObjectTrajectory, om::engine::graphics::GraphicsObjectTrajectory, om::engine::physics::RigidObjectTrajectory, and om::engine::animation::AnimationSequencerTrackTensor.

virtual Connection* om::engine::base::Connector::getConnection ( ) const

pure virtual

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

Implemented in om::engine::graphics::BoneTensor, om::engine::acoustics::SoundSourceTensor, om::engine::graphics::BoneTrajectory, om::engine::acoustics::SoundSourceTrajectory, om::engine::graphics::CameraTensor, om::engine::acoustics::SoundListenerTensor, om::engine::graphics::CameraTrajectory, om::engine::acoustics::SoundListenerTrajectory, om::engine::acoustics::SoundObjectTensor, om::engine::graphics::GraphicsObjectTensor, om::engine::physics::RigidObjectTensor, om::engine::acoustics::SoundObjectTrajectory, om::engine::graphics::GraphicsObjectTrajectory, om::engine::physics::RigidObjectTrajectory, and om::engine::animation::AnimationSequencerTrackTensor.

virtual void* om::engine::base::Connector::getObject ( ) const

inlinevirtual

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

Reimplemented in om::engine::graphics::BoneTensor, om::engine::acoustics::SoundSourceTensor, om::engine::graphics::BoneTrajectory, om::engine::acoustics::SoundSourceTrajectory, om::engine::graphics::CameraTensor, om::engine::acoustics::SoundListenerTensor, om::engine::graphics::CameraTrajectory, om::engine::acoustics::SoundListenerTrajectory, om::engine::acoustics::SoundObjectTensor, om::engine::graphics::GraphicsObjectTensor, om::engine::physics::RigidObjectTensor, om::engine::acoustics::SoundObjectTrajectory, om::engine::graphics::GraphicsObjectTrajectory, om::engine::physics::RigidObjectTrajectory, and om::engine::animation::AnimationSequencerTrackTensor.

virtual const ResourceType& om::engine::base::Connector::getObjectType ( ) const

inlinevirtual

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

Reimplemented in om::engine::graphics::BoneTensor, om::engine::acoustics::SoundSourceTensor, om::engine::graphics::BoneTrajectory, om::engine::acoustics::SoundSourceTrajectory, om::engine::graphics::CameraTensor, om::engine::acoustics::SoundListenerTensor, om::engine::graphics::CameraTrajectory, om::engine::acoustics::SoundListenerTrajectory, om::engine::acoustics::SoundObjectTensor, om::engine::graphics::GraphicsObjectTensor, om::engine::physics::RigidObjectTensor, om::engine::acoustics::SoundObjectTrajectory, om::engine::graphics::GraphicsObjectTrajectory, om::engine::physics::RigidObjectTrajectory, and om::engine::animation::AnimationSequencerTrackTensor.

virtual const ResourceType& om::engine::base::Connector::getType ( ) const

pure virtual

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

Implemented in om::engine::graphics::BoneTensor, om::engine::acoustics::SoundSourceTensor, om::engine::graphics::BoneTrajectory, om::engine::acoustics::SoundSourceTrajectory, om::engine::graphics::CameraTensor, om::engine::acoustics::SoundListenerTensor, om::engine::graphics::CameraTrajectory, om::engine::acoustics::SoundListenerTrajectory, om::engine::acoustics::SoundObjectTensor, om::engine::graphics::GraphicsObjectTensor, om::engine::physics::RigidObjectTensor, om::engine::acoustics::SoundObjectTrajectory, om::engine::graphics::GraphicsObjectTrajectory, om::engine::physics::RigidObjectTrajectory, and om::engine::animation::AnimationSequencerTrackTensor.

ConnectorFlags& om::engine::base::Connector::getFlags ( )

inline

Return a reference to an object that contains boolean parameters of the connector.

const ConnectorFlags& om::engine::base::Connector::getFlags ( ) const

inline

Return an object that contains boolean parameters of the connector.

void om::engine::base::Connector::setFlags ( const ConnectorFlags & newFlags )

inline

Set an object that contains boolean parameters of the connector.

Bool om::engine::base::Connector::flagIsSet ( ConnectorFlags::Flag flag ) const

inline

Return whether or not the specified boolan flag is set for this connector.

Bool om::engine::base::Connector::flagsAreSet ( const ConnectorFlags & otherFlags ) const

inline

Return whether or not all of the specified boolan flags are set for this connector.

void om::engine::base::Connector::setFlag	(	ConnectorFlags::Flag	flag,
		Bool	newIsSet = `true`
	)

inline

Set whether or not the specified boolan flag is set for this connector.

Bool om::engine::base::Connector::isDisabled ( ) const

inline

Return whether or not this connector is currently disabled.

Bool om::engine::base::Connector::getIsEnabled ( ) const

inline

Return whether or not this connector is currently enabled.

void om::engine::base::Connector::setIsEnabled ( Bool newIsEnabled )

inline

Set whether or not this connector should be enabled.

const SystemType& om::engine::base::Connector::getSystemType ( ) const

inline

Return an enum indicating the system type that determines when this connector should update.

void om::engine::base::Connector::setSystemType ( const SystemType & newSystemType )

inline

Set an enum indicating the system type that determines when this connector should update.

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

omEngineConnector.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation