import Transform from '@mobilizing/library/js/Mobilizing/renderer/3D/three/scene/Transform.js'

public class |source

Transform

Constructor Summary

Public Constructor
public	constructor() Transform class is meant to be aggregated to any object that needs to be transformed in space.

Member Summary

Public Members
public	children: *[]
public	mobObject: *
public	nativeObject: *
public	recursiveChildren: *[]

Method Summary

Public Methods
public	addChild(child: Transform Mesh) Adds a child to this transform (argument must be a transform too)
public	addChildren(child: Array) Adds a children array to this transform (argument must be a transform too)
public	getChild(index: Number): Object Gets one of all the children objects of this transform
public	getChildren(recursive: *): Array Gets an array containning all the children objects of this transform
public	getDirections(): Object Get the 3 direction vectors of this transform
public	getLocalEulerAngles(): *
public	getLocalMatrix(): Matrix4
public	getLocalPosition(): Vector3 Gets the local position of this transform
public	getLocalPositionX(): Number Gets the local x position of this transform
public	getLocalPositionY(): Number Gets the local x position of this transform
public	getLocalPositionZ(): Number Gets the local z position of this transform
public	getLocalQuaternion(): Quaternion Get the object rotation as a quarternion.
public	getLocalRotation(): Vector3 Get the current local rotation of this transform
public	getLocalRotationX(): Number Get the current x local rotation of this transform
public	getLocalRotationY(): Number Get the current y local rotation of this transform
public	getLocalRotationZ(): Number Get the current z local rotation of this transform
public	getLocalScale(): Vector3
public	getLocalScaleX(): Number
public	getLocalScaleY(): Number
public	getLocalScaleZ(): Number
public	getNativeObject(): *
public	getParent(): *
public	getRecurseChildren(transform: *)
public	getScreenCoordinates(context: Context, camera: Camera): Vector2 Return a Vector2 giving the screen coordinates of the object
public	getVisible(): *
public	getWorldMatrix(): * get the world matrix of the object
public	getWorldPosition(): Vector3
public	getWorldQuaternion(): * get the world quaternion of the object
public	lookAt(vector: Vector) Geneates a transform to point at a certain coordinates, makes the object "look at" this point.
public	pick(cam: Camera, x: number, y: number): Object Perform a RayCast picking
public	removeChild(child: Transform) Removes a child from the children chain
public	setLocalEulerAngles(arg1: , arg2: , arg3: *)
public	setLocalMatrix(m: *)
public	setLocalPosition(number\|Vector3\|Vector2: float \| Vector3 \| Vector2, Number: float, Number: float) Set the local position of the transform (and to the object attach to it).
public	setLocalPositionX(arg: Number) Sets this transform's x position
public	setLocalPositionY(arg: Number) Sets this transform's y position
public	setLocalPositionZ(arg: Number) Sets this transform's z position
public	setLocalQuaternion(quarternion: Quaternion) Set the object rotation with a quarternion {x,y,z,w}.
public	setLocalRotation(number\|Vector3\|Vector2: float \| Vector3 \| Vector2, Number: float, Number: float) Set the euler angles rotation in degrees.
public	setLocalRotationOrder(order: string) Defines the oreder of application for rotation axis.
public	setLocalRotationX(arg: Number) Sets this transform's x rotation
public	setLocalRotationY(arg: Number) Sets this transform's y rotation
public	setLocalRotationZ(arg: Number) Sets this transform's z rotation
public	setLocalScale(number\|Vector3\|Vector2: float \| Vector3 \| Vector2, Number: float, Number: float) Set the scale of the transform.
public	setLocalScaleX(arg: Number) Sets this transform's x scale
public	setLocalScaleY(arg: Number) Sets this transform's y scale
public	setLocalScaleZ(arg: Number) Sets this transform's z scale
public	setRenderOrder(the: Number) Sets the render order of this object.
public	setUpDirection(vector: *)
public	setVisible(val: Boolean) Set this object visibility

Public Constructors

public constructor() source

Transform class is meant to be aggregated to any object that needs to be transformed in space. Mesh, Light or Camera contains a transform instance.

Public Members

public children: *[] source

public mobObject: * source

public nativeObject: * source

public recursiveChildren: *[] source

Public Methods

public addChild(child: Transform Mesh) source

Adds a child to this transform (argument must be a transform too)

Params:

Name	Type	Attribute	Description
child	Transform Mesh

public addChildren(child: Array) source

Adds a children array to this transform (argument must be a transform too)

Params:

Name	Type	Attribute	Description
child	Array

public getChild(index: Number): Object source

Gets one of all the children objects of this transform

Params:

Name	Type	Attribute	Description
index	Number		Index of the child to get

Return:

Object

public getChildren(recursive: *): Array source

Gets an array containning all the children objects of this transform

Params:

Name	Type	Attribute	Description
recursive	*

Return:

Array

public getDirections(): Object source

Get the 3 direction vectors of this transform

Return:

Object

object with all 3 Vector3 as {upVector: upVector, forwardVector: forwardVector,leftVector: leftVector};

public getLocalEulerAngles(): * source

Return:

public getLocalMatrix(): Matrix4 source

Return:

Matrix4

local matrix of the object

public getLocalPosition(): Vector3 source

Gets the local position of this transform

Return:

Vector3

localPosition vector

public getLocalPositionX(): Number source

Gets the local x position of this transform

Return:

Number

localPosition x

public getLocalPositionY(): Number source

Gets the local x position of this transform

Return:

Number

localPosition y

public getLocalPositionZ(): Number source

Gets the local z position of this transform

Return:

Number

localPosition z

public getLocalQuaternion(): Quaternion source

Get the object rotation as a quarternion.

Return:

Quaternion

quarternion

public getLocalRotation(): Vector3 source

Get the current local rotation of this transform

Return:

Vector3

localRotation vector

public getLocalRotationX(): Number source

Get the current x local rotation of this transform

Return:

Number

localRotation x value

public getLocalRotationY(): Number source

Get the current y local rotation of this transform

Return:

Number

localRotation y value

public getLocalRotationZ(): Number source

Get the current z local rotation of this transform

Return:

Number

localRotation z value

public getLocalScale(): Vector3 source

Return:

Vector3

localScale vector

public getLocalScaleX(): Number source

Return:

Number

localScale x

public getLocalScaleY(): Number source

Return:

Number

localScale y

public getLocalScaleZ(): Number source

Return:

Number

localScale z

public getNativeObject(): * source

Return:

*	the Three.js native object used in this class

public getParent(): * source

Return:

public getRecurseChildren(transform: *) source

Params:

Name	Type	Attribute	Description
transform	*

public getScreenCoordinates(context: Context, camera: Camera): Vector2 source

Return a Vector2 giving the screen coordinates of the object

Params:

Name	Type	Attribute	Description
context	Context		the current Mobilizing context
camera	Camera		the Camera to use for the projection

Return:

Vector2

the screen coordinates of the object

public getVisible(): * source

Return:

*	the visibility of this object

public getWorldMatrix(): * source

get the world matrix of the object

Return:

*	world matrix of the object

public getWorldPosition(): Vector3 source

Return:

Vector3

world Position vector of the object

public getWorldQuaternion(): * source

get the world quaternion of the object

Return:

*	world quaternion of the object

public lookAt(vector: Vector) source

Geneates a transform to point at a certain coordinates, makes the object "look at" this point.

Params:

Name	Type	Attribute	Description
vector	Vector

public pick(cam: Camera, x: number, y: number): Object source

Perform a RayCast picking

Params:

Name	Type	Attribute	Description
cam	Camera		The camera to use as a ray caster.
x	number		The x coordinate in screen space for the ray casting
y	number		The y coordinate in screen space for the ray casting

Return:

Object

if picking success, gives an object as {point:{x,y,z} in world coordinates, uv:{u,v}, distance:dist}, null otherwise.

public removeChild(child: Transform) source

Removes a child from the children chain

Params:

Name	Type	Attribute	Description
child	Transform

public setLocalEulerAngles(arg1: , arg2: , arg3: *) source

Params:

Name	Type	Attribute	Description
arg1	*
arg2	*
arg3	*

public setLocalMatrix(m: *) source

Params:

Name	Type	Attribute	Description
m	*

public setLocalPosition(number|Vector3|Vector2: float | Vector3 | Vector2, Number: float, Number: float) source

Set the local position of the transform (and to the object attach to it). Polymorphic : can take various agruments of various types. Possible arguments number is 1, 2 or 3.

Params:

Name	Type	Attribute	Description
number\|Vector3\|Vector2	float \| Vector3 \| Vector2		Value for the new position of the transform. If a Vector3 is given, its x, y, z will be used for the position x, y, z. If a Vector2 is given, its x, y will be used for the position x and y, but z will be unchanged. If a number is given, it will be the position x.
Number	float		Value for the new y position of the transform.
Number	float		Value for the new z position of the transform.

public setLocalPositionX(arg: Number) source

Sets this transform's x position

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalPositionY(arg: Number) source

Sets this transform's y position

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalPositionZ(arg: Number) source

Sets this transform's z position

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalQuaternion(quarternion: Quaternion) source

Set the object rotation with a quarternion {x,y,z,w}.

Params:

Name	Type	Attribute	Description
quarternion	Quaternion		The quaternion to apply

public setLocalRotation(number|Vector3|Vector2: float | Vector3 | Vector2, Number: float, Number: float) source

Set the euler angles rotation in degrees. Polymorphic : can take various agruments of various types. Possible arguments number is 1, 2 or 3.

Params:

Name	Type	Attribute	Description
number\|Vector3\|Vector2	float \| Vector3 \| Vector2		Value for the new rotation of the transform. If a Vector3 is given, its x, y, z will be used for the rotation x, y, z. If a Vector2 is given, its x, y will be used for the rotation x and y, but z will be unchanged. If a number is given, it will be the position x.
Number	float		Value for the new y rotation of the transform.
Number	float		Value for the new z rotation of the transform.

public setLocalRotationOrder(order: string) source

Defines the oreder of application for rotation axis. Default is 'XYZ', others are'YZX', 'ZXY', 'XZY', 'YXZ' and 'ZYX'

Params:

Name	Type	Attribute	Description
order	string		one of 'XYZ', 'YZX', 'ZXY', 'XZY', 'YXZ' and 'ZYX'

public setLocalRotationX(arg: Number) source

Sets this transform's x rotation

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalRotationY(arg: Number) source

Sets this transform's y rotation

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalRotationZ(arg: Number) source

Sets this transform's z rotation

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalScale(number|Vector3|Vector2: float | Vector3 | Vector2, Number: float, Number: float) source

Set the scale of the transform. Polymorphic : can take various agruments of various types. Possible arguments number is 1, 2 or 3.

Params:

Name	Type	Attribute	Description
number\|Vector3\|Vector2	float \| Vector3 \| Vector2		Value for the new scale. If a Vector3 is given, its x, y, z will be used for the scale x, y, z. If a Vector2 is given, its x, y will be used for the scale x and y, but z will be 1. If a number is given, it will be the scale x.
Number	float		Value for the new y scale.
Number	float		Value for the new z scale.

public setLocalScaleX(arg: Number) source

Sets this transform's x scale

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalScaleY(arg: Number) source

Sets this transform's y scale

Params:

Name	Type	Attribute	Description
arg	Number

public setLocalScaleZ(arg: Number) source

Sets this transform's z scale

Params:

Name	Type	Attribute	Description
arg	Number

public setRenderOrder(the: Number) source

Sets the render order of this object. The sortObjects of the renderer should be true for this property to have any effect.

Params:

Name	Type	Attribute	Description
the	Number		render order index

public setUpDirection(vector: *) source

Params:

Name	Type	Attribute	Description
vector	*

public setVisible(val: Boolean) source

Set this object visibility

Params:

Name	Type	Attribute	Description
val	Boolean

Transform

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public children: *[] source

public mobObject: * source

public nativeObject: * source

public recursiveChildren: *[] source

Public Methods

public addChild(child: Transform Mesh) source

Params:

public addChildren(child: Array) source

Params:

public getChild(index: Number): Object source

Params:

Return:

public getChildren(recursive: *): Array source

Params:

Return:

public getDirections(): Object source

Return:

public getLocalEulerAngles(): * source

Return:

public getLocalMatrix(): Matrix4 source

Return:

public getLocalPosition(): Vector3 source

Return:

public getLocalPositionX(): Number source

Return:

public getLocalPositionY(): Number source

Return:

public getLocalPositionZ(): Number source

Return:

public getLocalQuaternion(): Quaternion source

Return:

public getLocalRotation(): Vector3 source

Return:

public getLocalRotationX(): Number source

Return:

public getLocalRotationY(): Number source

Return:

public getLocalRotationZ(): Number source

Return:

public getLocalScale(): Vector3 source

Return:

public getLocalScaleX(): Number source

Return:

public getLocalScaleY(): Number source

Return:

public getLocalScaleZ(): Number source

Return:

public getNativeObject(): * source

Return:

public getParent(): * source

Return:

public getRecurseChildren(transform: *) source

Params:

public getScreenCoordinates(context: Context, camera: Camera): Vector2 source

Params:

Return:

public getVisible(): * source

Return:

public getWorldMatrix(): * source

Return:

public getWorldPosition(): Vector3 source

Return:

public getWorldQuaternion(): * source

Return:

public lookAt(vector: Vector) source

Params:

public pick(cam: Camera, x: number, y: number): Object source

Params:

Return:

public removeChild(child: Transform) source

Params:

public setLocalEulerAngles(arg1: *, arg2: *, arg3: *) source

Params:

public setLocalEulerAngles(arg1: , arg2: , arg3: *) source