Namespace: lapi

lapi

Source:

Namespaces

CONSTANTS
CONSTANTS
utils
utils

Methods

<static> _initialize()

Initialize routine to cache embed scene data in local variables.

Source:

<static> _initialize()

Initialize routine to cache embed scene data in local variables.

Source:

<static> _messageIframe()

Pass messgage to SC

Source:

<static> _messageIframe()

Pass messgage to SC

Source:

<static> applyMaterialToMeshByName(in_materialName, in_meshName)

Apply a material to a mesh by using their names

Parameters:
Name Type Description
in_materialName String
in_meshName String
Source:
Example
 lapi.applyMaterialToMeshByName( "Glossy Diffuse", "Sphere" );

<static> applyMaterialToMeshByName(in_materialName, in_meshName)

Apply a material to a mesh by using their names

Parameters:
Name Type Description
in_materialName String
in_meshName String
Source:
Example
 lapi.applyMaterialToMeshByName( "Glossy Diffuse", "Sphere" );

<static> applyMaterialToObjectByGuid(in_materialGuid, in_meshGuid)

apply a material to an object by using their guid's

Parameters:
Name Type Description
in_materialGuid String
in_meshGuid String
Source:

<static> applyMaterialToObjectByGuid(in_materialGuid, in_meshGuid)

apply a material to an object by using their guid's

Parameters:
Name Type Description
in_materialGuid String
in_meshGuid String
Source:

<static> desselectAll()

Desselect all selected objects

Source:

<static> desselectAll()

Desselect all selected objects

Source:

<static> getActiveScene() → {lapi.Scene}

accessor to return the current loaded scene

Source:
Returns:
Type
lapi.Scene

<static> getActiveScene() → {lapi.Scene}

accessor to return the current loaded scene

Source:
Returns:
Type
lapi.Scene

<static> getCamera()

Get active camera return {SceneObject} camera

Source:

<static> getCamera()

Get active camera return {SceneObject} camera

Source:

<static> isPlaying() → {Boolean}

isPlaying test to know if we are in changing time

Source:
Returns:

playing status

Type
Boolean

<static> isPlaying() → {Boolean}

isPlaying test to know if we are in changing time

Source:
Returns:

playing status

Type
Boolean

<static> isRendering() → {Boolean}

isRendering

Source:
Returns:

rendering status

Type
Boolean

<static> isRendering() → {Boolean}

isRendering

Source:
Returns:

rendering status

Type
Boolean

<static> setCameraResolution(in_Params)

Set the camera resolution parameters to in_Params.width and in_Params.height, if either is missing the current value is preserved.

Parameters:
Name Type Description
in_Params Object

containing two members, width{Number} and height{Number} TODO move this routine into a specialized camera class

Source:

<static> setCameraResolution(in_Params)

Set the camera resolution parameters to in_Params.width and in_Params.height, if either is missing the current value is preserved.

Parameters:
Name Type Description
in_Params Object

containing two members, width{Number} and height{Number} TODO move this routine into a specialized camera class

Source:

<static> setObjectParameter()

Assign value to object property .

Source:

<static> setObjectParameter()

Assign value to object property .

Source:

<static> showToolbar()

method to control the display of the toolbar

Source:

<static> showToolbar()

method to control the display of the toolbar

Source:

<static> startRender()

startRender in the embeded scene

Source:

<static> startRender()

startRender in the embeded scene

Source:

<static> stopRender()

stopRender in the embeded scene

Source:

<static> stopRender()

stopRender in the embeded scene

Source:

Namespace: lapi

lapi

Source:

Namespaces

CONSTANTS
CONSTANTS
utils
utils

Methods

<static> _initialize()

Initialize routine to cache embed scene data in local variables.

Source:

<static> _initialize()

Initialize routine to cache embed scene data in local variables.

Source:

<static> _messageIframe()

Pass messgage to SC

Source:

<static> _messageIframe()

Pass messgage to SC

Source:

<static> applyMaterialToMeshByName(in_materialName, in_meshName)

Apply a material to a mesh by using their names

Parameters:
Name Type Description
in_materialName String
in_meshName String
Source:
Example
 lapi.applyMaterialToMeshByName( "Glossy Diffuse", "Sphere" );

<static> applyMaterialToMeshByName(in_materialName, in_meshName)

Apply a material to a mesh by using their names

Parameters:
Name Type Description
in_materialName String
in_meshName String
Source:
Example
 lapi.applyMaterialToMeshByName( "Glossy Diffuse", "Sphere" );

<static> applyMaterialToObjectByGuid(in_materialGuid, in_meshGuid)

apply a material to an object by using their guid's

Parameters:
Name Type Description
in_materialGuid String
in_meshGuid String
Source:

<static> applyMaterialToObjectByGuid(in_materialGuid, in_meshGuid)

apply a material to an object by using their guid's

Parameters:
Name Type Description
in_materialGuid String
in_meshGuid String
Source:

<static> desselectAll()

Desselect all selected objects

Source:

<static> desselectAll()

Desselect all selected objects

Source:

<static> getActiveScene() → {lapi.Scene}

accessor to return the current loaded scene

Source:
Returns:
Type
lapi.Scene

<static> getActiveScene() → {lapi.Scene}

accessor to return the current loaded scene

Source:
Returns:
Type
lapi.Scene

<static> getCamera()

Get active camera return {SceneObject} camera

Source:

<static> getCamera()

Get active camera return {SceneObject} camera

Source:

<static> isPlaying() → {Boolean}

isPlaying test to know if we are in changing time

Source:
Returns:

playing status

Type
Boolean

<static> isPlaying() → {Boolean}

isPlaying test to know if we are in changing time

Source:
Returns:

playing status

Type
Boolean

<static> isRendering() → {Boolean}

isRendering

Source:
Returns:

rendering status

Type
Boolean

<static> isRendering() → {Boolean}

isRendering

Source:
Returns:

rendering status

Type
Boolean

<static> setCameraResolution(in_Params)

Set the camera resolution parameters to in_Params.width and in_Params.height, if either is missing the current value is preserved.

Parameters:
Name Type Description
in_Params Object

containing two members, width{Number} and height{Number} TODO move this routine into a specialized camera class

Source:

<static> setCameraResolution(in_Params)

Set the camera resolution parameters to in_Params.width and in_Params.height, if either is missing the current value is preserved.

Parameters:
Name Type Description
in_Params Object

containing two members, width{Number} and height{Number} TODO move this routine into a specialized camera class

Source:

<static> setObjectParameter()

Assign value to object property .

Source:

<static> setObjectParameter()

Assign value to object property .

Source:

<static> showToolbar()

method to control the display of the toolbar

Source:

<static> showToolbar()

method to control the display of the toolbar

Source:

<static> startRender()

startRender in the embeded scene

Source:

<static> startRender()

startRender in the embeded scene

Source:

<static> stopRender()

stopRender in the embeded scene

Source:

<static> stopRender()

stopRender in the embeded scene

Source:
Copyright © 2011-2013 Lagoa built by TeamUp Technologies Inc.
Documentation generated by JSDoc 3.2.0-dev on Sat Mar 01 2014 11:49:52 GMT-0500 (EST) using the DocStrap template.