cgv
Loading...
Searching...
No Matches
vr::vr_controller_info Struct Reference

information provided for controller devices More...

#include <vr_info.h>

Inheritance diagram for vr::vr_controller_info:
vr::vr_trackable_info vr::vr_device_info

Public Member Functions

 vr_controller_info ()
 construct with default
 
- Public Member Functions inherited from vr::vr_trackable_info
 vr_trackable_info ()
 construct with default values
 
- Public Member Functions inherited from vr::vr_device_info
 vr_device_info ()
 construct empty info
 

Public Attributes

VRControllerType type
 controller type
 
VRControllerRole role
 controller role
 
int32_t nr_inputs
 number of used inputs
 
VRInputType input_type [max_nr_controller_inputs]
 type of up to 5vr::max_nr_controller_inputs inputs built into the controller
 
int32_t nr_axes
 total number of axes provided by all inputs
 
VRAxisType axis_type [max_nr_controller_axes]
 axis type for each of the vr::max_nr_controller_axes axes in the state
 
VRButtonStateFlags supported_buttons
 one flag per button telling whether it is supported
 
- Public Attributes inherited from vr::vr_trackable_info
std::string device_type
 type name of device
 
int32_t device_class
 index of device class
 
bool is_wireless
 whether device is wireless
 
bool provides_battery_charge_level
 whether one can query battery charge level
 
float battery_charge_level
 battery charge level in percentage (0 .. empty, 1 .. full)
 
bool has_proximity_sensor
 whether device has proximity sensor
 
- Public Attributes inherited from vr::vr_device_info
std::string serial_number
 unique identifier of device
 
std::string model_number
 number describing the device type
 
std::map< std::string, std::string > variable_parameters
 a map from parameter name to parameter value used for all device parameters that are not explicitly defined
 

Detailed Description

information provided for controller devices

Definition at line 119 of file vr_info.h.

Constructor & Destructor Documentation

◆ vr_controller_info()

vr::vr_controller_info::vr_controller_info ( )

construct with default

Definition at line 107 of file vr_info.cxx.

References axis_type, input_type, vr::max_nr_controller_axes, vr::max_nr_controller_inputs, nr_axes, nr_inputs, supported_buttons, and type.

Member Data Documentation

◆ axis_type

VRAxisType vr::vr_controller_info::axis_type[max_nr_controller_axes]

axis type for each of the vr::max_nr_controller_axes axes in the state

axes are enumerated in the order of the inputs. Typically, the first is a 2d input (pad or stick) with the corresponding axes indexed with 0 and 1. The first axis of the second input is in this case 2.

Definition at line 135 of file vr_info.h.

Referenced by vr::operator<<(), and vr_controller_info().

◆ input_type

VRInputType vr::vr_controller_info::input_type[max_nr_controller_inputs]

type of up to 5vr::max_nr_controller_inputs inputs built into the controller

Definition at line 128 of file vr_info.h.

Referenced by cgv::gui::vr_server::emit_events_and_update_state(), vr::operator<<(), and vr_controller_info().

◆ nr_axes

int32_t vr::vr_controller_info::nr_axes

total number of axes provided by all inputs

Definition at line 130 of file vr_info.h.

Referenced by vr::operator<<(), and vr_controller_info().

◆ nr_inputs

int32_t vr::vr_controller_info::nr_inputs

number of used inputs

Definition at line 126 of file vr_info.h.

Referenced by vr_test::on_device_change(), vr_test::on_status_change(), vr::operator<<(), and vr_controller_info().

◆ role

VRControllerRole vr::vr_controller_info::role

controller role

Definition at line 124 of file vr_info.h.

◆ supported_buttons

VRButtonStateFlags vr::vr_controller_info::supported_buttons

one flag per button telling whether it is supported

Definition at line 137 of file vr_info.h.

Referenced by vr::operator<<(), and vr_controller_info().

◆ type

VRControllerType vr::vr_controller_info::type

controller type

Definition at line 122 of file vr_info.h.

Referenced by vr_view_interactor::draw_vr_kits(), vr::operator<<(), and vr_controller_info().


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