DtHumanMovementControlOutputPortGroup Class Reference

An output port group that contains the ports necessary to control the movement of a human using the DtHumanMovementActuator. More...

Inheritance diagram for DtHumanMovementControlOutputPortGroup:

Public Member Functions
virtual	~DtHumanMovementControlOutputPortGroup ()
virtual DtAnalogOutputPort *	movementDirectionPort ()
	Output port indicating what direction the entity should move in.
virtual DtAnalogOutputPort *	facingDirectionPort ()
	Output port indicating what direction the entity should face.
virtual DtAnalogOutputPort *	speedPort ()
	Output port indicating how fast the entity should move.
Public Member Functions inherited from DtOutputPortGroup
	DtOutputPortGroup (const DtString &name)
	Constructor.
virtual	~DtOutputPortGroup ()
	Destructor.
virtual const DtString &	name () const
	Returns the name of this group.
virtual bool	anyPortsActive () const
	Returns true if any of the contained ports have an active connection.
virtual bool	allPortsActive () const
	Returns true only if ALL of the contained ports have an active connection.
virtual bool	attemptToActivate ()
	Calls attemptToActivate() on all contained ports.
virtual bool	canActivate ()
	Calls canActivate() on all contained ports.
virtual bool	attemptToActivateAllPorts ()
	Calls attemptToActivate() on all contained ports.
virtual bool	canActivateAllPorts ()
	Calls canActivate() on all contained ports.
virtual void	deactivate ()
	Calls deactivate() on all contained ports.
virtual void	allowDeactivation ()
	Calls allowDeactivation on all contained ports.
virtual void	sendData ()
	Calls sendData() on all contained ports.
virtual void	addPort (DtOutputPort *port)
	Add a new port to the group.
virtual void	removePort (DtOutputPort *port)
	Remove a port from the group.
virtual const DtList *	ports () const
	Returns the list of input ports in the group.
virtual const DtOutputPort *	port (const DtString &portName) const
	Returns a pointer to the named port in this group.
virtual DtOutputPort *	port (const DtString &portName)
	Non-const version of named port return.
virtual void	addConnection (DtPortGroupConnection *conn)
	Add an incomming connection to this port.
virtual void	removeConnection (DtPortGroupConnection *conn)
	Remove an incomming connection to this port.
virtual const DtList *	connectionList () const
	Returns the list of DtPortGroupConnection objects associated with this port group.
virtual void	setConnectionPriority (int priority)
	Sets the priority of all existing outgoing connections from this port group to the new priority.
virtual bool	anyPortsEnabled () const
	Returns true if any of the contained ports is enabled.
virtual bool	allPortsEnabled () const
	Returns true if all of the contained ports are enabled.
virtual void	disableAllPorts ()
	Enables/disables the port group.
virtual void	enableAllPorts ()

Static Public Member Functions
static DtHumanMovementControlOutputPortGroup *	create (const DtString &name)
	Creates a new instance of this class, and calls init() on it before returning the instance.

Protected Member Functions
	DtHumanMovementControlOutputPortGroup (const DtString &name)
	Use create() instead of the constructor.
virtual bool	init ()
	Virtual init method called during the creation process.

Protected Attributes
DtAnalogOutputPort *	myMovementDirectionOutputPort
DtAnalogOutputPort *	myFacingDirectionOutputPort
DtAnalogOutputPort *	mySpeedOutputPort
Protected Attributes inherited from DtOutputPortGroup
DtString	myName
DtHashlist *	myPortList
	List of output ports.
DtList	myConnectionList
	List of DtPortGroupConnection.

Private Member Functions
	DtHumanMovementControlOutputPortGroup ()
	Not Implemented.
	DtHumanMovementControlOutputPortGroup (const DtHumanMovementControlOutputPortGroup &)
	Not Implemented.
DtHumanMovementControlOutputPortGroup &	operator= (const DtHumanMovementControlOutputPortGroup &)
	Not Implemented.

Detailed Description

An output port group that contains the ports necessary to control the movement of a human using the DtHumanMovementActuator.

Note

This class is created using the static create() method instead of the constructor.

Constructor & Destructor Documentation

DtHumanMovementControlOutputPortGroup::DtHumanMovementControlOutputPortGroup ( const DtString &  name )

protected

Use create() instead of the constructor.

virtual DtHumanMovementControlOutputPortGroup::~DtHumanMovementControlOutputPortGroup ( )

virtual

DtHumanMovementControlOutputPortGroup::DtHumanMovementControlOutputPortGroup ( )

private

Not Implemented.

DtHumanMovementControlOutputPortGroup::DtHumanMovementControlOutputPortGroup ( const DtHumanMovementControlOutputPortGroup &  )

private

Not Implemented.

Member Function Documentation

static DtHumanMovementControlOutputPortGroup* DtHumanMovementControlOutputPortGroup::create ( const DtString &  name )

static

Creates a new instance of this class, and calls init() on it before returning the instance.

Use this method instead of the constructor.

virtual bool DtHumanMovementControlOutputPortGroup::init ( )

protectedvirtual

Virtual init method called during the creation process.

No need to call this method externally.

virtual DtAnalogOutputPort* DtHumanMovementControlOutputPortGroup::movementDirectionPort ( )

virtual

Output port indicating what direction the entity should move in.

Specified as a heading in radians.

virtual DtAnalogOutputPort* DtHumanMovementControlOutputPortGroup::facingDirectionPort ( )

virtual

Output port indicating what direction the entity should face.

Specified as a heading in radians.

virtual DtAnalogOutputPort* DtHumanMovementControlOutputPortGroup::speedPort ( )

virtual

Output port indicating how fast the entity should move.

Specified in meters/second.

DtHumanMovementControlOutputPortGroup& DtHumanMovementControlOutputPortGroup::operator= ( const DtHumanMovementControlOutputPortGroup &  )

private

Not Implemented.

Member Data Documentation

DtAnalogOutputPort* DtHumanMovementControlOutputPortGroup::myMovementDirectionOutputPort

protected

DtAnalogOutputPort* DtHumanMovementControlOutputPortGroup::myFacingDirectionOutputPort

protected

DtAnalogOutputPort* DtHumanMovementControlOutputPortGroup::mySpeedOutputPort

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/humanMovementControlPortGroup.h