dtCore::AxisToAxis Class Reference

Maps an axis to a logical axis with an optional linear transformation. More...

#include <logicalinputdevice.h>

Inheritance diagram for dtCore::AxisToAxis:

List of all members.

Public Member Functions
	AxisToAxis (Axis *sourceAxis, double scale=1.0, double offset=0.0)
	Constructor.
void	SetSourceAxis (Axis *sourceAxis)
	Sets the source axis.
Axis *	GetSourceAxis ()
	Returns the source axis.
virtual void	SetTargetAxis (LogicalAxis *targetAxis)
	Sets the target axis.
virtual LogicalAxis *	GetTargetAxis ()
	Gets the target axis.
void	SetTransformationParameters (double scale, double offset)
	Sets this mapping's linear transformation parameters.
void	GetTransformationParameters (double *scale, double *offset) const
	Retrieves this mapping's linear transformation parameters.
virtual bool	AxisStateChanged (const Axis *axis, double oldState, double newState, double delta)
	Called when an axis' state has changed.
Protected Member Functions
virtual	~AxisToAxis ()

---

Detailed Description

Maps an axis to a logical axis with an optional linear transformation.

---

Constructor & Destructor Documentation

dtCore::AxisToAxis::AxisToAxis	(	Axis *	sourceAxis,
		double	scale = 1.0,
		double	offset = 0.0
	)

Constructor.

Parameters:

	sourceAxis	the source axis
	scale	the optional scale parameter
	offset	the optional offset parameter

dtCore::AxisToAxis::~AxisToAxis

(

)

[protected, virtual]

---

Member Function Documentation

void dtCore::AxisToAxis::SetSourceAxis

(

Axis *

sourceAxis

)

Sets the source axis.

Parameters:

sourceAxis

the new source axis

Axis * dtCore::AxisToAxis::GetSourceAxis

(

)

Returns the source axis.

Returns:

the current source axis

void dtCore::AxisToAxis::SetTargetAxis

(

LogicalAxis *

targetAxis

)

[virtual]

Sets the target axis.

Parameters:

targetAxis

the new target axis

Implements dtCore::AxisMapping.

LogicalAxis * dtCore::AxisToAxis::GetTargetAxis

(

)

[virtual]

Gets the target axis.

Returns:

the current target axis

Implements dtCore::AxisMapping.

void dtCore::AxisToAxis::SetTransformationParameters	(	double	scale,
		double	offset
	)

Sets this mapping's linear transformation parameters.

Parameters:

	scale	the new scale parameter
	offset	the new offset parameter

void dtCore::AxisToAxis::GetTransformationParameters	(	double *	scale,
		double *	offset
	)			const

Retrieves this mapping's linear transformation parameters.

Parameters:

	scale	a pointer to the location in which to store the scale parameter
	offset	a pointer to the location in which to store the offset parameter

bool dtCore::AxisToAxis::AxisStateChanged	(	const Axis *	axis,
		double	oldState,
		double	newState,
		double	delta
	)			[virtual]

Called when an axis' state has changed.

Parameters:

	axis	the changed axis
	oldState	the old state of the axis
	newState	the new state of the axis
	delta	a delta value indicating stateless motion

Returns:

Whether the event was handled.

Parameters:

	axis	the changed axis
	oldState	the old state of the axis
	newState	the new state of the axis
	delta	a delta value indicating stateless motion

Implements dtCore::AxisListener.

---