opal::SensorData Class Reference

A data structure describing a Sensor. More...

#include <SensorData.h>

Inheritance diagram for opal::SensorData:

List of all members.

Public Member Functions
OPAL_DECL	SensorData ()
virtual OPAL_DECL	~SensorData ()
virtual OPAL_DECL SensorType OPAL_CALL	getType () const
Public Attributes
bool	enabled
std::string	name
Solid *	solid
int	internal_solidIndex
std::string	solidBlueprintRefName
Matrix44r	transform
Protected Attributes
SensorType	mType

---

Detailed Description

A data structure describing a Sensor.

Definition at line 47 of file SensorData.h.

---

Constructor & Destructor Documentation

OPAL_DECL opal::SensorData::SensorData (   )  [inline]

Definition at line 50 of file SensorData.h. References opal::ACCELERATION_SENSOR, opal::defaults::sensor::enabled, enabled, internal_solidIndex, mType, name, solid, and solidBlueprintRefName.

virtual OPAL_DECL opal::SensorData::~SensorData (   )  [inline, virtual]

Definition at line 63 of file SensorData.h.

---

Member Function Documentation

virtual OPAL_DECL SensorType OPAL_CALL opal::SensorData::getType (   )  const [inline, virtual]

Returns the Sensor's type. Definition at line 68 of file SensorData.h. References mType. Referenced by opal::Blueprint::addSensor(), opal::VolumeSensor::getType(), opal::RaycastSensor::getType(), opal::InclineSensor::getType(), and opal::AccelerationSensor::getType().

---

Member Data Documentation

bool opal::SensorData::enabled

True if the Sensor is enabled. Definition at line 74 of file SensorData.h. Referenced by opal::RaycastSensor::firePiercingRay(), opal::RaycastSensor::fireRay(), opal::InclineSensor::getAngle(), opal::AccelerationSensor::getGlobalAngularAccel(), opal::AccelerationSensor::getGlobalLinearAccel(), opal::AccelerationSensor::getLocalAngularAccel(), opal::AccelerationSensor::getLocalLinearAccel(), opal::VolumeSensor::internal_update(), opal::RaycastSensor::internal_update(), opal::InclineSensor::internal_update(), opal::AccelerationSensor::internal_update(), opal::VolumeSensor::isEnabled(), opal::RaycastSensor::isEnabled(), opal::InclineSensor::isEnabled(), opal::AccelerationSensor::isEnabled(), opal::VolumeSensorData::operator=(), opal::RaycastSensorData::operator=(), opal::InclineSensorData::operator=(), opal::AccelerationSensorData::operator=(), opal::VolumeSensor::queryVolume(), SensorData(), opal::VolumeSensor::setEnabled(), opal::RaycastSensor::setEnabled(), opal::InclineSensor::setEnabled(), and opal::AccelerationSensor::setEnabled().

int opal::SensorData::internal_solidIndex

Internal data used for Blueprint instantiation. Definition at line 85 of file SensorData.h. Referenced by opal::VolumeSensorData::operator=(), opal::RaycastSensorData::operator=(), opal::InclineSensorData::operator=(), opal::AccelerationSensorData::operator=(), and SensorData().

SensorType opal::SensorData::mType [protected]

The Sensor type. Definition at line 97 of file SensorData.h. Referenced by opal::AccelerationSensorData::AccelerationSensorData(), getType(), opal::InclineSensorData::InclineSensorData(), opal::VolumeSensorData::operator=(), opal::RaycastSensorData::operator=(), opal::InclineSensorData::operator=(), opal::AccelerationSensorData::operator=(), opal::RaycastSensorData::RaycastSensorData(), SensorData(), and opal::VolumeSensorData::VolumeSensorData().

std::string opal::SensorData::name

An identifier for the Sensor. Definition at line 77 of file SensorData.h. Referenced by opal::Blueprint::addSensor(), opal::VolumeSensor::getName(), opal::RaycastSensor::getName(), opal::InclineSensor::getName(), opal::AccelerationSensor::getName(), opal::VolumeSensorData::operator=(), opal::RaycastSensorData::operator=(), opal::InclineSensorData::operator=(), opal::AccelerationSensorData::operator=(), SensorData(), opal::VolumeSensor::setName(), opal::RaycastSensor::setName(), opal::InclineSensor::setName(), and opal::AccelerationSensor::setName().

Solid* opal::SensorData::solid

Pointer to the Solid to which this Sensor is attached. This will be NULL if the Sensor is not attached to a Solid (i.e. it is just positioned somewhere within the environment). Definition at line 82 of file SensorData.h. Referenced by opal::RaycastSensor::firePiercingRay(), opal::RaycastSensor::fireRay(), opal::InclineSensor::getAngle(), opal::AccelerationSensor::getGlobalAngularAccel(), opal::AccelerationSensor::getGlobalLinearAccel(), opal::AccelerationSensor::getLocalAngularAccel(), opal::AccelerationSensor::getLocalLinearAccel(), opal::VolumeSensor::internal_dependsOnSolid(), opal::RaycastSensor::internal_dependsOnSolid(), opal::InclineSensor::internal_dependsOnSolid(), opal::AccelerationSensor::internal_dependsOnSolid(), opal::VolumeSensor::internal_update(), opal::RaycastSensor::internal_update(), opal::InclineSensor::internal_update(), opal::AccelerationSensor::internal_update(), opal::VolumeSensorData::operator=(), opal::RaycastSensorData::operator=(), opal::InclineSensorData::operator=(), opal::AccelerationSensorData::operator=(), opal::VolumeSensor::queryVolume(), SensorData(), opal::InclineSensor::setAxis(), and opal::InclineSensor::setupInternalVectors().

std::string opal::SensorData::solidBlueprintRefName

String used for for intra-Blueprint references. Definition at line 88 of file SensorData.h. Referenced by opal::VolumeSensorData::operator=(), opal::RaycastSensorData::operator=(), opal::InclineSensorData::operator=(), opal::AccelerationSensorData::operator=(), and SensorData().

Matrix44r opal::SensorData::transform

If the Sensor is attached to a Solid, this transform is the global offset from that Solid's transform. Otherwise, it is just the Sensor's global transform. Definition at line 93 of file SensorData.h. Referenced by opal::RaycastSensor::firePiercingRay(), opal::RaycastSensor::fireRay(), opal::VolumeSensor::getTransform(), opal::RaycastSensor::getTransform(), opal::InclineSensor::getTransform(), opal::AccelerationSensor::getTransform(), opal::VolumeSensorData::operator=(), opal::RaycastSensorData::operator=(), opal::InclineSensorData::operator=(), opal::AccelerationSensorData::operator=(), opal::VolumeSensor::queryVolume(), opal::VolumeSensor::setTransform(), opal::RaycastSensor::setTransform(), opal::InclineSensor::setTransform(), and opal::AccelerationSensor::setTransform().

---

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

• SensorData.h

---