PLInput::Connection Class Reference

Connection between two controllers/controls. More...

#include <Connection.h>

List of all members.

Public Member Functions
PLINPUT_API	Connection (Control *pInput, Control *pOutput, float fScale=1.0f)
	Constructor.
virtual PLINPUT_API	~Connection ()
	Destructor.
PLINPUT_API Control *	GetInputControl () const
	Get input control.
PLINPUT_API Control *	GetOutputControl () const
	Get output control.
PLINPUT_API bool	IsValid () const
	Check if connection is value.
virtual PLINPUT_API void	PassValue ()
	Pass value from input to output.
virtual PLINPUT_API void	PassValueBackwards ()
	Pass value backwards from output to input.
Protected Attributes
Control *	m_pInput
Control *	m_pOutput
bool	m_bValid
float	m_fScale

---

Detailed Description

Connection between two controllers/controls.

---

Constructor & Destructor Documentation

PLINPUT_API PLInput::Connection::Connection	(	Control *	pInput,
		Control *	pOutput,
		float	fScale = 1.0f
	)

Constructor.

Parameters:

[in]	pInput	Input control, can be a null pointer
[in]	pOutput	Output control, can be a null pointer
[in]	fScale	Scale factor

virtual PLINPUT_API PLInput::Connection::~Connection

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLINPUT_API Control* PLInput::Connection::GetInputControl

(

)

const

Get input control.

Returns:

Pointer to control that is on the input side of the connection, can be a null pointer

PLINPUT_API Control* PLInput::Connection::GetOutputControl

(

)

const

Get output control.

Returns:

Pointer to control that is on the output side of the connection, can be a null pointer

PLINPUT_API bool PLInput::Connection::IsValid

(

)

const

Check if connection is value.

Returns:

'true' if connection is valid, else 'false'

Remarks:

A connection is invalid e.g. when you try to connect different types of controls without using the proper connection type (see derived classes for connection classes that can convert values into other types). It is also not valid to use a control of a device as an output, because devices can only be used as input, not as output of controls (a device is controlled by the physical device only).

virtual PLINPUT_API void PLInput::Connection::PassValue

(

)

[virtual]

Pass value from input to output.

virtual PLINPUT_API void PLInput::Connection::PassValueBackwards

(

)

[virtual]

Pass value backwards from output to input.

---

Member Data Documentation

Control* PLInput::Connection::m_pInput [protected]

Input control, can be a null pointer

Control* PLInput::Connection::m_pOutput [protected]

Output control, can be a null pointer

bool PLInput::Connection::m_bValid [protected]

'true' if connection is valid, else 'false'

float PLInput::Connection::m_fScale [protected]

Scale factor

---

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

• PLInput/include/PLInput/Input/Connection/Connection.h