Virtual Robot Racing League

Developer Center

VRRL
IOrientedSensor Interface Reference

A sensor that has a pre-defined orientation More...

Inheritance diagram for IOrientedSensor:
IRobotSensor IDistanceSensor

Public Member Functions

SensorOrientations GetOrientation ()
 Gets the orientation of this sensor More...
 
void GetCustomOrientation (out double x, out double y, out double z)
 Gets a unit vector representing the custom orientation (if GetOrientation() returns SensorOrientations.Custom) The vector will be relative to the orientation of the robot More...
 

Additional Inherited Members

- Properties inherited from IRobotSensor
IRobotExplorer Robot [get]
 The robot this sensor is attached to More...
 
int SensorIndex [get]
 The index of this sensor in the robot's list of sensors More...
 

Detailed Description

A sensor that has a pre-defined orientation

Member Function Documentation

◆ GetCustomOrientation()

void IOrientedSensor.GetCustomOrientation ( out double  x,
out double  y,
out double  z 
)

Gets a unit vector representing the custom orientation (if GetOrientation() returns SensorOrientations.Custom) The vector will be relative to the orientation of the robot

Parameters
xThe x-component of the unit vector orientation
yThe y-component of the unit vector orientation
zThe z-component of the unit vector orientation

◆ GetOrientation()

SensorOrientations IOrientedSensor.GetOrientation ( )

Gets the orientation of this sensor

Returns
The orientation type of this sensor