MEMBERS

inheritedTypes :object

IncisorAPI.js, line 11228

Dictionary object listing all of the types this object is compatible with.

readonly type :string

IncisorAPI.js, line 11222

Type identifier.

w :number

IncisorAPI.js, line 11252

The fourth component of this Vector.

x :number

IncisorAPI.js, line 11234

The first component of this Vector.

y :number

IncisorAPI.js, line 11240

The second component of this Vector.

z :number

IncisorAPI.js, line 11246

The third component of this Vector.

METHODS

clone() returns {Vector4}

IncisorAPI.js, line 11319

Returns a new Vector4 with the same component values as this Vector.

Returns:

Vector4

copy(vector)

IncisorAPI.js, line 11306

Sets all of this Vector's component values to the component values of the given Vector.

Parameters:

Name	Type	Attributes	Default	Description
vector	Vector4			The Vector to copy component values from.

isEqual(vector) returns {boolean}

IncisorAPI.js, line 11313

Determines if all of the components of this Vector are equal to their counterparts in the given Vector.

Parameters:

Name	Type	Attributes	Default	Description
vector	Vector4			The Vector to compare against.

Returns:

boolean

multiply(vector)

IncisorAPI.js, line 11283

Multiplies all components of this Vector by the given Vector.

Parameters:

Name	Type	Attributes	Default	Description
vector	Vector4			The Vector to multiply this Vector by.

Example:

// Objective: Use the multiply function to change the color of the white box.
// Expected Result: You will see a denim blue box.

// create a GraphicObject using the WhiteBox asset
let box = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// create a color to multiply with the box's default color (1,1,1,1)
let colorMultiplier = new Color( 0, .5, 1, .8 );
// multiplying results in a final color of (0, .5, 1, .8) 
box.fillColor.multiply( colorMultiplier );

multiplyByValues(x (opt), y (opt), z (opt), w (opt))

IncisorAPI.js, line 11300

Multiplies the components of this Vector by the values provided.

Parameters:

Name	Type	Attributes	Default	Description
x	number	<optional>		The value to multiply the first component by. [DEFAULT: 1]
y	number	<optional>		The value to multiply the second component by. [DEFAULT: 1]
z	number	<optional>		The value to multiply the third component by. [DEFAULT: 1]
w	number	<optional>		The value to multiply the fourth component by. [DEFAULT: 1]

Example:

// Objective: Use the multiplyByValues function to change the color of the white box.
// Expected Result: You will see a denim blue box.

// create a GraphicObject using the WhiteBox asset
let box = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// multiplying with the box's default color (1,1,1,1) results in a final color of (0, .5, 1, .8) 
box.fillColor.multiplyByValues( 0, .5, 1, .8  );

scaleByFactor(factor)

IncisorAPI.js, line 11267

Multiplies all Vector components by the given factor.

Parameters:

Name	Type	Attributes	Default	Description
factor	number			The value to multiply the Vector components by.

Example:

// Objective: Use the scaleByFactor to change the color of the white box.
// Expected Result: You will see a half transparent gray box.

// create a GraphicObject using the WhiteBox asset
let box = new GraphicObject( nc.graphicAssets.WhiteBox, nc.mainScene, "Box" );
// multiplying with the box's default color (1,1,1,1) results in a final color of (.5, .5, .5, .5) 
box.fillColor.scaleByFactor( .5 );