Main| Guide| API| GitHub| Wiki| FAQ

B.Graph.Locator() -> B.Graph.Node

Represents a locator (transformed location in 3D-space).

To create the object use B.Graph.makeLocator().

METHODS:

move(offset)

Moves the locator by a given offset vector.

PARAMETERS:

{B.Math.Vector3} offset

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

move(ox, oy, oz)

Moves the locator by given offsets.

PARAMETERS:

{number} ox

offset along X-axis

{number} oy

offset along Y-axis

{number} oz

offset along Z-axis

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

rotate(axis, angle)

Rotates the locator around an arbitrary axis.

PARAMETERS:

{B.Math.Vector3} axis

{number} angle

in radians

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

rotate(object)

Rotates the locator by a quaternion or canonized euler angles.

PARAMETERS:

{B.Math.Quaternion | B.Math.Angles} object

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

scale(coeffs)

Scales the locator by a given coefficient vector.

PARAMETERS:

{B.Math.Vector3} coeffs

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

scale(cx, cy, cz)

Scales the locator by given coefficients.

PARAMETERS:

{number} cx

scale along X-axis

{number} cy

scale along Y-axis

{number} cz

scale along Z-axis

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

scale(c)

Scales the locator uniformly by a given coefficient.

PARAMETERS:

{number} c

scale along all axis uniformly

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

transform(matrix)

Add a given transformation to the locator transformation.

PARAMETERS:

{B.Math.Matrix3 | B.Math.Matrix4} matrix

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

transform()

Gets the locator transformation.

RETURNS:

{B.Math.Matrix4}

FIRES:

transformed

setTransform(matrix)

Sets the locator transformation (overwrites the current).

PARAMETERS:

{B.Math.Matrix3 | B.Math.Matrix4} [matrix] = B.Math.Matrix4.IDENTITY

RETURNS:

{B.Graph.Locator}

this

FIRES:

transformed

finalTransform()

Gets locator's final (world) transformation.

RETURNS:

{B.Math.Matrix4}

position(result)

Gets locator's world position.

PARAMETERS:

{B.Math.Vector3} [result]

omit if you want to return newly created vector

RETURNS:

{B.Math.Vector3}

EVENTS:

{B.Std.Event} transformed

Reporting that the locator has been transformed.

METHODS:

EVENTS: