Class TransformWidget

This is the base class for all objects that can be added to a GopherGfx 3D scene. It is named "Node" because the scene is stored in a graph data structure, so we think of every element in that graph as a "node" in the graph. There is also a "Node2" base class for all objects that can be added to the 2D scene.

Every object that can be added to a 3D scene (e.g., Lights, Mesh3s) will inherit from this base object. So, every object in the scene will have a position, rotation, scale, boundingBox, boundingSphere, visibility, and all of the other properties listed in this class.

For more detail on how the scene graph works, see the documentation for the Scene class.

Hierarchy

Constructors

constructor

Properties

_localBoundingBox _localBoundingSphere _position _rotation _scale _worldBoundingBox _worldBoundingSphere axes boundingBox boundingSphere children currentAxis deviceCoords localBoundsDirty localMatrixDirty localMatrixNegScale localMatrixUpdated localToParentMatrix localToWorldMatrix parent selectionPlane thickAxes visible worldBoundsDirty worldMatrixDirty

Accessors

localBoundingBox localBoundingSphere position rotation scale worldBoundingBox worldBoundingSphere

Methods

add composeLocalMatrix decomposeLocalMatrix draw getLocalToParentMatrix intersects isSelected lookAt onMouseDown onMouseMove onMouseUp remove removeChild setLights setLocalToParentMatrix traverseSceneGraph update updateLocalBounds updateWorldBounds updateWorldMatrix

Constructors

constructor

  • Constructor for the TransformWidget class

    Parameters

    • lineLength: number = 1

      The length of each line in the axes, default = 1

    • selectionWidth: number = 0.01

      The width of each selected axis line

    • triggerDistance: number = 0.05

      The maximum distance from the axis line that can trigger selection

    Returns TransformWidget

Properties

Protected _localBoundingBox

_localBoundingBox: BoundingBox3

Bounding box in this transform's local coordinate space

Protected _localBoundingSphere

_localBoundingSphere: BoundingSphere

Bounding circle in this transform's local coordinate space

Protected _position

_position: Vector3

The position of this node as a Vector3.

Protected _rotation

_rotation: Quaternion

The rotation of this transform represented as a quaternion.

Protected _scale

_scale: Vector3

The scale of this node as a Vector3.

Protected _worldBoundingBox

_worldBoundingBox: BoundingBox3

Bounding box in the world coordinate space

Protected _worldBoundingSphere

_worldBoundingSphere: BoundingSphere

Bounding box in the world coordinate space

axes

axes: Line3

boundingBox

boundingBox: BoundingBox3

The bounding box in vertex coordinate space

boundingSphere

boundingSphere: BoundingSphere

The bounding sphere in vertex coordinate space

children

children: Node3[]

Private currentAxis

currentAxis: number

Private deviceCoords

deviceCoords: Vector2

localBoundsDirty

localBoundsDirty: boolean

Protected localMatrixDirty

localMatrixDirty: boolean

Protected localMatrixNegScale

localMatrixNegScale: boolean

Protected localMatrixUpdated

localMatrixUpdated: boolean

Protected localToParentMatrix

localToParentMatrix: Matrix4

The local transformation matrix of this node.

localToWorldMatrix

localToWorldMatrix: Matrix4

The world transformation matrix of this node.

parent

parent: null | Node3

The parent transform of this transform. Null if this transform has no parent.

Private selectionPlane

selectionPlane: Plane3

thickAxes

thickAxes: Mesh3[]

visible

visible: boolean

Whether this transform is currently visible in the scene.

worldBoundsDirty

worldBoundsDirty: boolean

Protected worldMatrixDirty

worldMatrixDirty: boolean

Accessors

localBoundingBox

localBoundingSphere

position

rotation

scale

worldBoundingBox

worldBoundingSphere

Methods

add

composeLocalMatrix

decomposeLocalMatrix

draw

  • Draws this transform and all its children in the scene graph.

    Parameters

    • parent: Node3

      The parent transform of this transform.

    • camera: Camera

      The camera used to view the scene.

    • lightManager: LightManager

      The light manager used to manage the lights in the scene.

    Returns void

getLocalToParentMatrix

intersects

  • Checks for intersection between this Node3 and another

    Returns

    Whether or not the two objects intersect

    Parameters

    • other: Node3

      The other Node3 object

    • mode: IntersectionMode3 = IntersectionMode3.BOUNDING_SPHERE

      The IntersectionMode3 to use for the comparison (default: BOUNDING_SPHERE)

    • space: CoordinateSpace3 = CoordinateSpace3.LOCAL_SPACE

      The CoordinateSpace3 to use for the comparison (default: LOCAL_SPACE)

    Returns boolean

isSelected

  • Checks if the TransformWidget is currently selected

    Returns

    True if the TransformWidget is selected, false otherwise

    Returns boolean

lookAt

  • Rotates this Node3 object to look at the given target with the given up vector

    Parameters

    • target: Vector3

      The Vector3 representing the target in world space

    • up: Vector3 = Vector3.UP

      The Vector3 representing the up direction (defaults to Vector3.UP)

    • coordinateSpace: CoordinateSpace3 = CoordinateSpace3.LOCAL_SPACE

    Returns void

onMouseDown

  • Handles a mouse down event, checking for intersection with the thickAxes and setting currentAxis if one is found

    Parameters

    • event: MouseEvent

      The MouseEvent

    Returns void

onMouseMove

  • Handles a mouse move event, updating the deviceCoords

    Parameters

    • event: MouseEvent

      The MouseEvent

    Returns void

onMouseUp

  • Handles a mouse up event, resetting the currentAxis

    Parameters

    • event: MouseEvent

      The MouseEvent

    Returns void

remove

  • Removes the current Node3 from its parent Node3

    Returns

    true if the Node3 was successfully removed, false otherwise

    Returns boolean

removeChild

setLights

setLocalToParentMatrix

traverseSceneGraph

  • Traverses the scene graph starting from this Node3 object and updates the world matrices of all Node3 objects in the graph.

    Parameters

    • parentMatrixDirty: boolean = false

    Returns void

update

  • Updates the TransformWidget based on the deltaTime value

    Parameters

    • deltaTime: number

      The amount of time that has passed since the last update

    Returns void

updateLocalBounds

updateWorldBounds

updateWorldMatrix

  • Updates the world matrix of this Node3 by computing the multiplication of its local matrix with its parent's world matrix (if it has a parent).

    Returns

    void

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc