H3D::SphereSensor Class Reference
[X3D node classes.]

The SphereSensor node maps pointing device motion into spherical rotation about the origin of the local coordinate system. More...

#include <H3D/SphereSensor.h>

Inheritance diagram for H3D::SphereSensor:

Inheritance graph

List of all members.

Classes

class  Set_SphereEvents
 The Set_SphereEvents field takes care of sending trackPoint_changed, rotation_changed, and offset events when they should be sent. More...

Public Member Functions

 SphereSensor (Inst< SFBool > _autoOffset=0, Inst< SFString > _description=0, Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFRotation > _offset=0, Inst< SFBool > _isActive=0, Inst< SFBool > _isOver=0, Inst< SFRotation > _rotation_changed=0, Inst< SFVec3f > _trackPoint_changed=0)
 Constructor.

Public Attributes

auto_ptr< SFRotationoffset
 When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation_changed value.
auto_ptr< SFRotationrotation_changed
 For each position of the bearing when isActive is true, a rotation_changed event is sent which corresponds to the sum of the relative rotation from the original intersection point plus the offset value.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.

Protected Member Functions

virtual void onIsOver (IntersectionInfo *result=0, Matrix4f *global_to_local=0)
 Called to generate isOver events and other events (dependent on isOver) if they should be generated.


Detailed Description

The SphereSensor node maps pointing device motion into spherical rotation about the origin of the local coordinate system.

The SphereSensor node uses the descendent geometry of its parent node to determine whether it is liable to generate events.

The description field in the SphereSensor node specifies a textual description of the SphereSensor node. This may be used by browser-specific user interfaces that wish to present users with more detailed information about the SphereSensor.

The enabled field enables and disables the SphereSensor node. If enabled is TRUE, the sensor reacts appropriately to user events. If enabled is FALSE, the sensor does not track user input or send events. If enabled receives a FALSE event and isActive is TRUE, the sensor becomes disabled and deactivated, and outputs an isActive FALSE event. If enabled receives a TRUE event the sensor is enabled and ready for user activation.

The SphereSensor node generates events when the pointing device is activated while the pointer is indicating any descendent geometry nodes of the sensor's parent group.

Upon activation of the pointing device (e.g., mouse button down) over the sensor's geometry, an isActive TRUE event is sent. The vector defined by the initial point of intersection on the SphereSensor's geometry and the local origin determines the radius of the sphere that is used to map subsequent pointing device motion while dragging. The virtual sphere defined by this radius and the local origin at the time of activation is used to interpret subsequent pointing device motion and is not affected by any changes to the sensor's coordinate system while the sensor is active. For each position of the bearing, a rotation_changed event is sent which corresponds to the sum of the relative rotation from the original intersection point plus the offset value. trackPoint_changed events reflect the unclamped drag position on the surface of this sphere. When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation_changed value and an offset_changed event is generated.

While the pointing device is activated, trackPoint_changed and rotation_changed events are output. trackPoint_changed events represent the unclamped intersection points on the surface of the invisible sphere. If the pointing device is dragged off the sphere while activated, browsers may interpret this in a variety of ways (e.g., clamp all values to the sphere or continue to rotate as the point is dragged away from the sphere). Each movement of the pointing device while isActive is TRUE generates trackPoint_changed and rotation_changed events.

Internal routes:
SphereSensor.dot

Member Function Documentation

void SphereSensor::onIsOver ( IntersectionInfo result = 0,
Matrix4f *  global_to_local = 0 
) [protected, virtual]

Called to generate isOver events and other events (dependent on isOver) if they should be generated.

Reimplemented from H3D::X3DPointingDeviceSensorNode.

References H3D::X3DSensorNode::isActive, H3D::X3DPointingDeviceSensorNode::new_value, and IntersectionInfo::point.


Member Data Documentation

When the pointing device is deactivated and autoOffset is TRUE, offset is set to the last rotation_changed value.

Access type: inputOutput
Default value: 0 1 0 0

SphereSensor_offset.dot

Referenced by SphereSensor(), and H3D::SphereSensor::Set_SphereEvents::update().

For each position of the bearing when isActive is true, a rotation_changed event is sent which corresponds to the sum of the relative rotation from the original intersection point plus the offset value.

Access type: outputOnly
SphereSensor_rotation_changed.dot

Referenced by H3D::SphereSensor::Set_SphereEvents::update().


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

Generated on Fri Nov 7 10:31:02 2008 for H3D API by  doxygen 1.5.7