DtConstrainedDualAxisAnalogInputPort Class Reference

Contains class declarations for DtConstrainedDualAxisInputPort and DtConstrainedDualAxisOutputPort. More...

Inheritance diagram for DtConstrainedDualAxisAnalogInputPort:

Public Member Functions
	DtConstrainedDualAxisAnalogInputPort (const DtString &portName)
virtual	~DtConstrainedDualAxisAnalogInputPort ()
virtual void	receiveData (DtPortData *data)
	Overridden from base class for optimization. More...
virtual void	setMinXValue (double minVal)
virtual double	minXValue () const
virtual void	setMaxXValue (double maxVal)
virtual double	maxXValue () const
virtual void	setMinYValue (double minVal)
virtual double	minYValue () const
virtual void	setMaxYValue (double maxVal)
virtual double	maxYValue () const
Public Member Functions inherited from DtDualAxisAnalogInputPort
	DtDualAxisAnalogInputPort (const DtString &portName)
virtual	~DtDualAxisAnalogInputPort ()
virtual bool	acceptType (const DtString &type) const
	Accepts DtDualAxisAnalogPortDataType. More...
virtual double	XValue () const
	Return the x value. More...
virtual double	YValue () const
	Return the y value. More...
Public Member Functions inherited from DtSingleConnectionInputPort
	DtSingleConnectionInputPort (const DtString &portName)
	Constructor. More...
virtual	~DtSingleConnectionInputPort ()
	Destructor. More...
virtual void	receiveData (DtPortData *data, const DtPortConnection *conn=0)
	clones the specified DtPortData into myData, and sets the newDataFlag to true. More...
virtual const DtPortData *	data () const
	Returns the current pointer to a port data. More...
virtual bool	attemptToActivateConnection (DtPortConnection *conn, int connectionPriority)
	Attempt to make this connection the active connection providing data to this port with the specified priority. More...
virtual bool	canActivate (const DtPortConnection *conn, int connectionPriority) const
	Checks if this connection can be the active connection. More...
virtual void	deactivateConnection (DtPortConnection *conn)
	If conn is the currently active connection, it is deactivated and this port has no active input connection. More...
virtual bool	activeConnection () const
	Returns true if there is an active connection into this port. More...
virtual bool	connectionActive (const DtPortConnection *connection) const
	Returns true if the specified connection is currently active. More...
virtual int	connectionPriority () const
	Returns the current connection priority. More...
Public Member Functions inherited from DtInputPort
	DtInputPort (const DtString &portName)
	Constructor. More...
virtual	~DtInputPort ()
	Destructor. More...
virtual const DtString &	name () const
	Returns the name string of this port. More...
virtual void	addConnection (DtPortConnection *conn)
	Add an incomming connection to this port. More...
virtual void	removeConnection (DtPortConnection *conn)
	Remove an incomming connection to this port. More...
virtual const DtList *	connectionList () const
	Returns the list of input connections to this port. More...
virtual bool	newData () const
	Returns true if there is new data on this port that has not been received. More...
virtual void	dataReceived ()
	Clears the newData flag on this port. More...
virtual bool	enabled () const
	Enables/disables the port. More...
virtual void	setEnabled (bool flag)

Protected Attributes
double	myMaxXValue
double	myMinXValue
double	myMaxYValue
double	myMinYValue
Protected Attributes inherited from DtSingleConnectionInputPort
DtPortData *	myData
int	myConnectionPriority
DtPortConnection *	myActiveConnection
Protected Attributes inherited from DtInputPort
DtString	myName
bool	myNewDataFlag
bool	myEnabled
DtList	myConnectionList

Detailed Description

Contains class declarations for DtConstrainedDualAxisInputPort and DtConstrainedDualAxisOutputPort.

Instances of DtConstrainedDualAxisAnalogInputPort are input ports through which data consumers can receive information values from a device such as a joystick that has two axes of motion. It represents this by creating two DtConstrainedAnalogPorts called myXValue and myYValue. Both are constrained to the range -1.0 to 1.0 by default.

Constructor & Destructor Documentation

DtConstrainedDualAxisAnalogInputPort::DtConstrainedDualAxisAnalogInputPort

(

const DtString &

portName

)

virtual DtConstrainedDualAxisAnalogInputPort::~DtConstrainedDualAxisAnalogInputPort ( )

virtual

Member Function Documentation

virtual void DtConstrainedDualAxisAnalogInputPort::receiveData ( DtPortData *  data )

virtual

Overridden from base class for optimization.

This function copies the double instead of cloning the port data.

Reimplemented from DtDualAxisAnalogInputPort.

virtual void DtConstrainedDualAxisAnalogInputPort::setMinXValue ( double  minVal )

virtual

virtual double DtConstrainedDualAxisAnalogInputPort::minXValue ( ) const

virtual

virtual void DtConstrainedDualAxisAnalogInputPort::setMaxXValue ( double  maxVal )

virtual

virtual double DtConstrainedDualAxisAnalogInputPort::maxXValue ( ) const

virtual

virtual void DtConstrainedDualAxisAnalogInputPort::setMinYValue ( double  minVal )

virtual

virtual double DtConstrainedDualAxisAnalogInputPort::minYValue ( ) const

virtual

virtual void DtConstrainedDualAxisAnalogInputPort::setMaxYValue ( double  maxVal )

virtual

virtual double DtConstrainedDualAxisAnalogInputPort::maxYValue ( ) const

virtual

Member Data Documentation

double DtConstrainedDualAxisAnalogInputPort::myMaxXValue

protected

double DtConstrainedDualAxisAnalogInputPort::myMinXValue

protected

double DtConstrainedDualAxisAnalogInputPort::myMaxYValue

protected

double DtConstrainedDualAxisAnalogInputPort::myMinYValue

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfobjcore/constrainedDualAxisAnalogIOPort.h