Parameters:
Type | Name | Description |
---|---|---|
actor
|
the actor to be added to the scene |
Parameters:
Type | Name | Description |
---|---|---|
vxlModel |
model
|
the model from which a new actor will be created AND added to this sceneIf you are looking to create but not adding an actor call new vxlActor(model) instead. |
Returns:
actor the actor that was created and added to the scene, from the model passed as parameter |
Parameters:
Type | Name | Description |
---|---|---|
Object |
name
|
name of the actor group |
Object |
list
|
list of actors to add to the actor group. Elements in the list can beactor classes, actors UID, actor names or any combination of these. |
See:
Parameters:
Type | Name | Description |
---|---|---|
[ vxlModel ] |
models
|
a list of models to create actors from |
Parameters:
Type | Name | Description |
---|---|---|
actorNameOrUID
|
|
Parameters:
Type | Name | Description |
---|---|---|
String |
cellUID
|
|
Returns:
{vxlActor|null} |
Parameters:
Type | Name | Description |
---|---|---|
name
|
the name of the actor to retrieve |
Parameters:
Type | Name | Description |
---|---|---|
UID
|
the actor's UID |
Returns:
{Array} a list with the actor names |
Returns a list of actors based on the condition passed as parameter.
The condition is a function with the following signature:
condition(vxlActor): returns boolean
If the condition evaluates true then that actor is included in the results
Parameters:
Type | Name | Description |
---|---|---|
function |
condition
|
the condition to evaluate in the actor list it receives an actor as a parameter |
Returns:
{Array} list of actors |
Parameters:
Type | Name | Description |
---|---|---|
String |
event
|
This event should be defined in vxl.events |
Object |
the
|
source that sent the event. Useful for callbacks |
Parameters:
Type | Name | Description |
---|---|---|
vxlActor|String |
actor
|
the actor object or the actor name to verify |
Parameters:
Type | Name | Description |
---|---|---|
actor
|
the actor to be removed from the scene |
Parameters:
Type | Name | Description |
---|---|---|
vxlFrameAnimation |
animation
|
the animation to set on this scene |
See:
vxlFrameAnimationParameters:
Type | Name | Description |
---|---|---|
mode
|
one of the valid loading modes |
See:
Parameters:
Type | Name | Description |
---|---|---|
lutID
|
the lookup table id |
Parameters:
Type | Name | Description |
---|---|---|
o
|
opacity value [0..1] |
|
name
|
the name of the actor whose opacity will be changed. If this parameter is missing, the opacity of all actors will be changed. |
Parameters:
Type | Name | Description |
---|---|---|
Array |
list
|
list of actors (String or vxlActor) |
String |
property
|
the name of the actor property |
Object |
value
|
the value of the property |
Parameters:
Type | Name | Description |
---|---|---|
String |
property
|
the name of the actor property |
Object |
value
|
the value of the property |
Parameters:
Type | Name | Description |
---|---|---|
mode
|
the visualization mode. It can be... TODO |
Parameters:
Type | Name | Description |
---|---|---|
actor
|
the actor to be updated |