// Objective: Instantiate a Color and add a red box.
// Expected Result: You should see a red box.

// Create a Color using the Color constructor. Set the red value to 1 and green and blue to zero.
let red = new Color( 1, 0, 0, 1 );
// Create a GraphicObject using the GraphicObject constructor. Use the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "RedBox" );
// Set the GraphicObject's fillColor property to the new red Color.
myGraphicObject.fillColor = red;

MEMBERS

addMotion :ColorAddMotion

IncisorAPI.js, line 11408

Object housing the built-in 'addMotion' functions for this Vector's components.

Example:

// Objective: Add motion to the changing Colors of a box.
// Expected Result: You will see a box continuously changing colors as the red, green and blue values adjust up and down over different time intervals.

// Create a Color using the Color constructor. Initially, it will default to white.
let color = new Color();
// Create a GraphicObject using the GraphicObject constructor. Use the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "RedBox" );
// Set the GraphicObject's fillColor property to the new Color.
myGraphicObject.fillColor = color;
// Add motion to the red, green and blue values over different time intervals.
color.addMotion.red( 0, 1, .04 );
color.addMotion.green( 0, 1, .09 );
color.addMotion.blue( 0, 1, 1.5 );

alpha :number

IncisorAPI.js, line 11460

The alpha value of this Color.

Example:

// Objective: Get the alpha value of a Color.
// Expected Result: The console should read "The alpha value is 0.5".

// Create a color using the Color constructor. Set the alpha value to 0.5.
let color = new Color( 0, 0, 0, 0.5 );
console.log("The alpha value is", color.alpha);

blue :number

IncisorAPI.js, line 11447

The blue value of this Color.

Example:

// Objective: Get the blue value of a Color.
// Expected Result: The console should read "The blue value is 0.5".

// Create a color using the Color constructor. Set the blue value to 0.5.
let color = new Color( 0, 0, 0.5, 1 );
console.log("The blue value is", color.blue);

green :number

IncisorAPI.js, line 11434

The green value of this Color.

Example:

// Objective: Get the green value of a Color.
// Expected Result: The console should read "The green value is 0.5".

// Create a color using the Color constructor. Set the green value to 0.5.
let color = new Color( 0, 0.5, 0, 1 );
console.log("The green value is", color.green);

red :number

IncisorAPI.js, line 11421

The red value of this Color.

Example:

// Objective: Get the red value of a Color.
// Expected Result: The console should read "The red value is 0.5".

// Create a color using the Color constructor. Set the red value to 0.5.
let color = new Color( 0.5, 0, 0, 1 );
console.log("The red value is", color.red);

swoop :ColorSwoop

IncisorAPI.js, line 11388

Object housing the built-in swoopers for this Vector's components.

Example:

// Objective: Swoop the Color of a GraphicObject.
// Expected Result: You will see a red box fade to black over a period of 10 seconds, then fade back to red over a period of 5 seconds.

// Create a Color using the Color constructor. Initially, make it red.
let color = new Color( 1, 0, 0, 1 );
// Create a GraphicObject using the GraphicObject constructor. Use the white box GraphicAsset and add it to the main Scene.
let myGraphicObject = new GraphicObject( nc.graphicAssets.whiteBox, nc.mainScene, "RedBox" );
// Set the GraphicObject's fillColor property to the new Color (initially red).
myGraphicObject.fillColor = color;
// Swoop the red color down to zero over 10 seconds then swoop it back to 1 over 5 seconds.
color.swoop.red( 0, 10, undefined, color.swoop, "red", [1,5] );

Members below are inherited from the parent class.

inheritedTypes :object

IncisorAPI.js, line 11228

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

Inherited From:

• Vector4Base.inheritedTypes()

readonly type :string

IncisorAPI.js, line 11222

Type identifier.

Inherited From:

• Vector4Base.type()

w :number

IncisorAPI.js, line 11252

The fourth component of this Vector.

Inherited From:

• Vector4Base.w()

x :number

IncisorAPI.js, line 11234

The first component of this Vector.

Inherited From:

• Vector4Base.x()

y :number

IncisorAPI.js, line 11240

The second component of this Vector.

Inherited From:

• Vector4Base.y()

z :number

IncisorAPI.js, line 11246

The third component of this Vector.

Inherited From:

• Vector4Base.z()

METHODS

Methods below are inherited from the parent class.

clone() returns {Vector4}

IncisorAPI.js, line 11319

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

Returns:

Vector4

Inherited From:

• Vector4Base.clone()

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.

Inherited From:

• Vector4Base.copy()

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

Inherited From:

• Vector4Base.isEqual()

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.

Inherited From:

• Vector4Base.multiply()

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]

Inherited From:

• Vector4Base.multiplyByValues()

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.

Inherited From:

• Vector4Base.scaleByFactor()

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 );