API Reference

Class TPlaneSensorNode

Description
Hierarchy
Fields
Methods
Properties

Unit

X3DNodes

Declaration

type TPlaneSensorNode = class(TAbstractDragSensorNode)

Description

Pointing device sensor to move objects on a plane.

Hierarchy

Overview

Methods

Public procedure Activate(const Time: TX3DTime; const ATransform, AInvertedTransform: TMatrix4; const OverPoint: TVector3); override;
Public procedure Deactivate(const Time: TX3DTime); override;
Public procedure Drag(const Time: TX3DTime; const RayOrigin, RayDirection: TVector3); override;
Public procedure CreateNode; override;
Public class function ClassX3DType: String; override;

Properties

Public property FdAxisRotation: TSFRotation read FFdAxisRotation;
Public property AxisRotation: TVector4 read GetAxisRotation write SetAxisRotation;
Public property FdMaxPosition: TSFVec2f read FFdMaxPosition;
Public property MaxPosition: TVector2 read GetMaxPosition write SetMaxPosition;
Public property FdMinPosition: TSFVec2f read FFdMinPosition;
Public property MinPosition: TVector2 read GetMinPosition write SetMinPosition;
Public property FdOffset: TSFVec3f read FFdOffset;
Public property Offset: TVector3 read GetOffset write SetOffset;
Public property EventTranslation_changed: TSFVec3fEvent read FEventTranslation_changed;

Description

Methods

Public procedure Activate(const Time: TX3DTime; const ATransform, AInvertedTransform: TMatrix4; const OverPoint: TVector3); override;

This item has no description. Showing description inherited from TAbstractPointingDeviceSensorNode.Activate.

Activate pointing device sensor. Used by the events engine (like TCastleSceneCore) to notify this sensor.

OverPoint indicates 3D point (in global, that is TCastleSceneCore, coordinates) pointed by the mouse.

In TAbstractPointingDeviceSensorNode class, this simply sends isActive := TRUE event.

Public procedure Deactivate(const Time: TX3DTime); override;

This item has no description. Showing description inherited from TAbstractPointingDeviceSensorNode.Deactivate.

Deactivate pointing device sensor. Used by the events engine (like TCastleSceneCore) to notify this sensor.

In TAbstractPointingDeviceSensorNode class, this simply sends isActive := FALSE event.

Public procedure Drag(const Time: TX3DTime; const RayOrigin, RayDirection: TVector3); override;

This item has no description. Showing description inherited from TAbstractDragSensorNode.Drag.

Called by events engine (like TCastleSceneCore) when you move your mouse over the active drag sensor.

Public procedure CreateNode; override;

Create node fields and events.

Public class function ClassX3DType: String; override;

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Properties

Public property FdAxisRotation: TSFRotation read FFdAxisRotation;

Internal wrapper for property AxisRotation. This wrapper API may change, we advise to access simpler AxisRotation instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property AxisRotation: TVector4 read GetAxisRotation write SetAxisRotation;

This item has no description.

Public property FdMaxPosition: TSFVec2f read FFdMaxPosition;

Internal wrapper for property MaxPosition. This wrapper API may change, we advise to access simpler MaxPosition instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MaxPosition: TVector2 read GetMaxPosition write SetMaxPosition;

This item has no description.

Public property FdMinPosition: TSFVec2f read FFdMinPosition;

Internal wrapper for property MinPosition. This wrapper API may change, we advise to access simpler MinPosition instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property MinPosition: TVector2 read GetMinPosition write SetMinPosition;

This item has no description.

Public property FdOffset: TSFVec3f read FFdOffset;

Internal wrapper for property Offset. This wrapper API may change, we advise to access simpler Offset instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Public property Offset: TVector3 read GetOffset write SetOffset;

This item has no description.

Public property EventTranslation_changed: TSFVec3fEvent read FEventTranslation_changed;

This item has no description.

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.