NSXRInput Class Reference

This class represents an input device in the world. More...

#include <NSXRInput.h>

Public Member Functions
void	NSXRInput (void)
virtual void	SetType (xrinput_t)
	Sets the NSXRInput type. More...
virtual void	SetParentSpace (NSXRSpace)
	Sets which NSXRSpace this input belongs to. More...
virtual vector	GetOrigin (void)
	Returns the world space position of this NSXRInput. More...
virtual vector	GetAngles (void)
	Returns the direction this NSXRInput is facing. More...
virtual vector	GetVelocity (void)
	Returns the current velocity of this NSXRInput. More...
virtual vector	GetAngularVelocity (void)
	Returns the rotational movement of this NSXRInput. More...
virtual unsigned int	GetStatus (void)
	Returns the status of the NSXRInput. More...
virtual unsigned int	GetWeapon (void)
	Returns the weapon this NSXRInput is wielding. More...
virtual xrinput_t	GetType (void)
	Returns the type of NSXRInput, check xrinput_t for details. More...
virtual bool	IsAvailable (void)
	Returns if this NSXRInput is available/active. More...
virtual void	InputFrame (void)
	Run every single input event. More...
virtual void	PrintInfo (void)
	Debug function that can be called every single frame. More...

Detailed Description

This class represents an input device in the world.

An input device can be a few different things. They can interpret updates from an external source, such as a VR headset or a VR controller. In the case of a headset (XR_INPUT_HEAD) it will let Nuclide know where we will position the client's NSView within the world.

Other sources, such as keyboard and mice can totally position and control these inputs as well.

Each input has the ability to have a NSWeapon reference tied to it. That way you can dual (or even triple) wield them.

Constructor & Destructor Documentation

NSXRInput()

void NSXRInput::NSXRInput

(

void

)

Member Function Documentation

GetAngles()

vector NSXRInput::GetAngles ( void  )

virtual

Returns the direction this NSXRInput is facing.

GetAngularVelocity()

vector NSXRInput::GetAngularVelocity ( void  )

virtual

Returns the rotational movement of this NSXRInput.

GetOrigin()

vector NSXRInput::GetOrigin ( void  )

virtual

Returns the world space position of this NSXRInput.

GetStatus()

unsigned int NSXRInput::GetStatus ( void  )

virtual

Returns the status of the NSXRInput.

GetType()

xrinput_t NSXRInput::GetType ( void  )

virtual

Returns the type of NSXRInput, check xrinput_t for details.

GetVelocity()

vector NSXRInput::GetVelocity ( void  )

virtual

Returns the current velocity of this NSXRInput.

GetWeapon()

unsigned int NSXRInput::GetWeapon ( void  )

virtual

Returns the weapon this NSXRInput is wielding.

InputFrame()

void NSXRInput::InputFrame ( void  )

virtual

Run every single input event.

IsAvailable()

bool NSXRInput::IsAvailable ( void  )

virtual

Returns if this NSXRInput is available/active.

PrintInfo()

void NSXRInput::PrintInfo ( void  )

virtual

Debug function that can be called every single frame.

SetParentSpace()

void NSXRInput::SetParentSpace ( NSXRSpace  xrSpace )

virtual

Sets which NSXRSpace this input belongs to.

SetType()

void NSXRInput::SetType ( xrinput_t  type )

virtual

Sets the NSXRInput type.

---

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

• src/xr/NSXRInput.h
• src/xr/NSXRInput.qc