makVre::DtVreJoystickControllerDescriptor Class Reference

Detailed Description

This class defines a descriptor for joystick controller components in VREngage. It extends the base joystick device controller descriptor to add configuration for port group assignment, allowing joystick inputs to be directed to appropriate control systems in the simulation.

#include <vreJoystickControllerDescriptor.h>

Inheritance diagram for makVre::DtVreJoystickControllerDescriptor:

Public Member Functions
	DtVreJoystickControllerDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	DtVreJoystickControllerDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVreJoystickControllerDescriptor (const DtVreJoystickControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtVreJoystickControllerDescriptor () override
DtVreJoystickControllerDescriptor &	operator= (const DtVreJoystickControllerDescriptor &orig)
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual std::string	portGroupName () const
virtual void	setPortGroupName (std::string name)

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Attributes
DtRwString	myPortGroupName

Private Member Functions
	DtVreJoystickControllerDescriptor ()

Constructor & Destructor Documentation

DtVreJoystickControllerDescriptor() [1/4]

makVre::DtVreJoystickControllerDescriptor::DtVreJoystickControllerDescriptor ( )

private

Default constructor (not implemented)

Default constructor is private and not implemented to prevent creation of instances without proper initialization.

Referenced by DtVreJoystickControllerDescriptor(), and operator=().

DtVreJoystickControllerDescriptor() [2/4]

makVre::DtVreJoystickControllerDescriptor::DtVreJoystickControllerDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with component name.

Parameters

componentName	The name of this component
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new joystick controller descriptor with the specified name.

DtVreJoystickControllerDescriptor() [3/4]

makVre::DtVreJoystickControllerDescriptor::DtVreJoystickControllerDescriptor	(	const DtSymbolString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with component name as symbol string.

Parameters

componentName	The name of this component as a symbol string
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new joystick controller descriptor with the specified name.

DtVreJoystickControllerDescriptor() [4/4]

makVre::DtVreJoystickControllerDescriptor::DtVreJoystickControllerDescriptor	(	const DtVreJoystickControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Copy constructor.

Parameters

orig	The source descriptor to copy from
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new joystick controller descriptor as a copy of the provided original.

References DtVreJoystickControllerDescriptor().

~DtVreJoystickControllerDescriptor()

virtual makVre::DtVreJoystickControllerDescriptor::~DtVreJoystickControllerDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

Member Function Documentation

operator=()

DtVreJoystickControllerDescriptor & makVre::DtVreJoystickControllerDescriptor::operator=

(

const DtVreJoystickControllerDescriptor &

orig

)

Assignment operator.

Parameters

orig	The source descriptor to copy from

Returns

Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtVreJoystickControllerDescriptor().

type()

virtual DtString makVre::DtVreJoystickControllerDescriptor::type ( ) const

overridevirtual

Gets the type identifier for this descriptor.

Returns

String identifying this descriptor type

Returns a unique type identifier string for this descriptor type. Will return DtVreJoystickControllerDescriptorType.

clone()

virtual DtComponentDescriptor * makVre::DtVreJoystickControllerDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

overridevirtual

Creates a clone of this descriptor.

Parameters

parentRegistry

Parent registry for reader/writer functionality (optional)

Returns

Pointer to a new descriptor that is a clone of this one

Creates a new joystick controller descriptor as a deep copy of this one.

creator()

static DtComponentDescriptor * makVre::DtVreJoystickControllerDescriptor::creator ( )

static

Factory function to create a new instance of this descriptor.

Returns

Pointer to a newly created descriptor

Static factory function used by the descriptor creation system to instantiate new instances of this descriptor type.

portGroupName()

virtual std::string makVre::DtVreJoystickControllerDescriptor::portGroupName ( ) const

virtual

Gets the port group name.

Returns

String identifying the port group

Returns the name of the port group that this joystick controller is assigned to. Port groups are used to direct joystick inputs to appropriate control systems.

setPortGroupName()

virtual void makVre::DtVreJoystickControllerDescriptor::setPortGroupName ( std::string name )

virtual

Sets the port group name.

Parameters

name	String identifying the port group

Sets the name of the port group that this joystick controller is assigned to. Port groups are used to direct joystick inputs to appropriate control systems.

Member Data Documentation

myPortGroupName

DtRwString makVre::DtVreJoystickControllerDescriptor::myPortGroupName

protected

Port group name.

The name of the port group that this joystick controller is assigned to. Port groups are used to direct joystick inputs to appropriate control systems.

---

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

• include/vrfExtensions/vreVrfobjparam/vreJoystickControllerDescriptor.h