official documentation

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

Class: PlaneSensor

X3D: 3.3
Component: PointingDeviceSensor
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. PlaneSensor

PlaneSensor converts pointing device motion into 2D translation, parallel to the local Z=0 plane. Hint: You can constrain translation output to one axis by setting the respective minPosition and maxPosition members to equal values for that axis.

HTML Encoding and Default Values⤴

<PlaneSensor autoOffset='true' axisRotation='0,0,1,0' enabled='true' maxPosition='-1,-1' metadata='X3DMetadataObject' minPosition='0,0' offset='0,0,0' planeOrientation=''XY'' ></PlaneSensor>

Inheritance⤴


Constructor⤴

PlaneSensor(ctx)⤴

Constructor for PlaneSensor

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,0,1,0 The local sensor coordinate system is created by additionally applying the axisRotation field value to the local coordinate system of the sensor node.
enabled SFBool true X3DSensorNode Specifies whether this sensor is enabled. A disabled sensor does not produce any output.
maxPosition SFVec2f -1,-1 The minPosition and maxPosition fields allow to constrain the 2D output of the plane sensor, along each 2D component. If the value of a component in maxPosition is smaller than the value of a component in minPosition, output is not constrained along the corresponding direction.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
minPosition SFVec2f 0,0 The minPosition and maxPosition fields allow to constrain the 2D output of the plane sensor, along each 2D component. If the value of a component in maxPosition is smaller than the value of a component in minPosition, output is not constrained along the corresponding direction.
offset SFVec3f 0,0,0 Offset value that is incorporated into the translation output of the sensor. This value is automatically updated if the value of the autoOffset field is 'true'.
planeOrientation SFString 'XY' Tracking plane orientation in local coordinate system. Valid values are "XY" and "screen". "screen" uses the current orientation of the screen.


Properties⤴

Access Name Type Inheritance Description
_worldToLocalMatrix World-To-Local matrix for this node, including the axisRotation of the sensor