official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: CylinderSensor

X3D: 3.3
Component: PointingDeviceSensor
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. CylinderSensor

The CylinderSensor node converts pointer motion (for example, from a mouse) into rotation values, using an invisible cylinder of infinite height, aligned with local Y-axis.

HTML Encoding and Default Values⤴

<CylinderSensor autoOffset='true' axisRotation='0,1,0,0' axisRotation='pi/2' axisRotation='0' axisRotation='-1' enabled='true' metadata='X3DMetadataObject' offset='0' ></CylinderSensor>

Inheritance⤴


Constructor⤴

CylinderSensor(ctx)⤴

Constructor for CylinderSensor

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
autoOffset SFBool true X3DDragSensorNode Determines whether offset values from previous drag gestures are remembered / accumulated.
axisRotation SFRotation 0,1,0,0 The local sensor coordinate system is created by additionally applying the axisRotation field value to the local coordinate system of the sensor node.
axisRotation SFFloat pi/2 Specifies whether the virtual cylinder's lateral surface or end-cap disks of virtual-geometry sensor are used for manipulation: If the vertical acute angle between the vector from the viewer to the point of intersection with the sensor geometry and the local Y axis of the cylinder is greater than or equal to the value of this field, the sensor uses a virtual cylinder to compute rotation output. Otherwise, if the angle is smaller than the value of this field, the sensor uses a virtual disk instead. This value of this field is specified in radians. ATTENTION: The value of this field is currently ignored. The cylinder sensor will always operate in cylinder mode.
axisRotation SFFloat 0 The minAngle and maxAngle fields, given in radians, allow to constrain the rotation output of the cylinder sensor. If the value of maxAngle is smaller than the value of minAngle, output is not constrained.
axisRotation SFFloat -1 The minAngle and maxAngle fields, given in radians, allow to constrain the rotation output of the cylinder sensor. If the value of maxAngle is smaller than the value of minAngle, output is not constrained.
enabled SFBool true X3DSensorNode Specifies whether this sensor is enabled. A disabled sensor does not produce any output.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
offset SFFloat 0 Offset value, in radians, that is incorporated into the rotation output of the sensor. This value is automatically updated if the value of the autoOffset field is 'true'.