All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class improv.actor.Actor

java.lang.Object
   |
   +----improv.actor.Actor

public final class Actor

extends Object

implements PropertyContainer

Actor(String, NYUSplashScreen)

The Actor constructor

Actor(String, VRMLManager)

addChannel(Channel)

Adds a Channel to the actor

addLayer(Layer)

Adds a Layer to an Actor

addLayer(String)

Adds a Layer to an Actor

addLayer(String, float, int)

Adds a Layer to an Actor

addProperty(ImprovProperty)

Adds a property to the Actor

channelExists(String)

Tests to see if a given channel exists.

deleteLayer(int)

Delete a Layer given its position in the Layer order

deleteLayer(String)

Delete a Layer given its name

doFrame()

Do one cycle of behavior

getBehavior(String)

getChannel(int)

get Channel by its position in the Channel list

getChannel(String)

get Channel by name

getChannelName(int)

Get Channel name by its position in the Channel list

getLayer(int)

getLayer(String)

getLayers()

getName()

getNumberOfChannels()

getNumberOfLayers()

getProperty(String)

Gets an actor property given the property name

hasChannel(String)

hasLayer(String)

hasPanel()

hasProperty(String)

insertLayer(Layer, int)

Insert a Layer at the specified position in the Layer order.

insertLayer(String, int)

Insert a Layer at the specified position in the Layer order.

renameLayer(Layer, String)

Rename a Layer given the Layer and the new name

renameLayer(String, String)

Rename a Layer given its current name and the new name

setBehavior(Behavior)

Activate a Behavior

setBehavior(String)

Activate a Behavior given its name.
Note: multiple Behaviors may share a name in which case each behavior with that name will be activated

setBehavior(String, double)

Activate a behavior given its name, and temporarily set its duration.

setBehavior(String, double, boolean)

Activate a behavior given its name, and temporarily set its duration, and momentary flag.
Next time the behavior is activated it will return to its default duration, and momentary flag.

setHasPanel(boolean)

This method has no effect on the functionality of the actor, but may be used to determine whether an author-defined GUI control panel should be displayed.

setProperty(String, float)

 public Actor(String n,
              NYUSplashScreen splash)

The Actor constructor

 public Actor(String n,
              VRMLManager m)

 public void addChannel(Channel channel)

Adds a Channel to the actor

 public boolean channelExists(String channelName)

Tests to see if a given channel exists.

Returns:

true if the channel exists, otherwise false.

 public Layer addLayer(String layerName)

Adds a Layer to an Actor

Parameters:

layerName - the name of the layer to be added.

Returns:

the layer added.

 public Layer addLayer(String layerName,
                       float opacity,
                       int composite)

Adds a Layer to an Actor

Parameters:

layerName - the name of the layer to be added.

opacity - the default opacity of the layer.

composite - the default compocite mode of the layer.

Returns:

the layer added.

 public Layer addLayer(Layer layer)

Adds a Layer to an Actor

Returns:

the Layer object.

 public Layer insertLayer(String layerName,
                          int position)

Insert a Layer at the specified position in the Layer order.

Parameters:

layerName - the name of the Layer to be added

position - the position in the layerlist to add the item

Returns:

the Layer object

 public Layer insertLayer(Layer layer,
                          int position)

Insert a Layer at the specified position in the Layer order.

Parameters:

layer - the Layer to be added

position - the position in the layer order to add the item

Returns:

the Layer object

 public void deleteLayer(int position)

Delete a Layer given its position in the Layer order

Parameters:

the - Layer's position in the layer order.

 public void deleteLayer(String layerName)

Delete a Layer given its name

Parameters:

layerName - the name of the Layer to be deleted.

 public void renameLayer(Layer layer,
                         String newName)

Rename a Layer given the Layer and the new name

Parameters:

newName - the new name of the Layer

 public void renameLayer(String oldName,
                         String newName)

Rename a Layer given its current name and the new name

Parameters:

oldName - the old name of the Layer

newName - the new name of the Layer

 public String getChannelName(int position)

Get Channel name by its position in the Channel list

Parameters:

position - the position in the channel list

Returns:

the name of the channel

 public Channel getChannel(int position)

get Channel by its position in the Channel list

Parameters:

position - the position in the channel list

Returns:

the channel

 public Channel getChannel(String channelName)

get Channel by name

Parameters:

channelName - the name of the channel

Returns:

the channel

 public int getNumberOfChannels()

Returns:

the number of channels in the channel list of this Actor

 public void doFrame()

Do one cycle of behavior

 public void setBehavior(String behaviorName)

Activate a Behavior given its name.
Note: multiple Behaviors may share a name in which case each behavior with that name will be activated

Parameters:

behaviorName - the name of the State or Sequence to be activated.

 public void setBehavior(Behavior behavior)

Activate a Behavior

Parameters:

behaviorName - the name of the State or Sequence to be activated.

 public void setBehavior(String behaviorName,
                         double duration)

Activate a behavior given its name, and temporarily set its duration. Next time the behavior is activated it will return to its default duration.

Parameters:

behaviorName - the State or Sequence to be activated

duration - the temporary duration of the State or Sequence.

 public void setBehavior(String behaviorName,
                         double duration,
                         boolean momentary)

Activate a behavior given its name, and temporarily set its duration, and momentary flag.
Next time the behavior is activated it will return to its default duration, and momentary flag.

Parameters:

behaviorName - the name of the behavior to be activated.

duration - the temporary duration value of the behavior

momentary - the temporary momentary value of the behavior

 public Behavior getBehavior(String behaviorName)

Returns:

the first behavior with the given name. If the Actor has no behaviors by that name, return null

 public boolean hasProperty(String propertyName)

 public void setProperty(String property,
                         float value)

 public void setHasPanel(boolean hasPanel)

This method has no effect on the functionality of the actor, but may be used to determine whether an author-defined GUI control panel should be displayed.

Parameters:

hasPanel - sets whether or not a author-defined GUI panel should be displayed

 public boolean hasPanel()

Returns:

the value set with the setHasPanel method

 public boolean hasChannel(String channelName)

Parameters:

channelName - the name of the channel being tested for.

Returns:

true if the Actor has a Channel by the given name.

 public boolean hasLayer(String layerName)

Parameters:

layerName - the name of the layer being tested for.

Returns:

true if the Actor has a Layer by the given name.

 public String getName()

Returns:

the Actor's name.

 public Layer[] getLayers()

Returns:

the Layers array.

 public Layer getLayer(int layerNum)

Parameters:

layerNum - the position of the layer in the Layers array.

Returns:

the Layer at the specified position in the Layers Array.

 public Layer getLayer(String layerName)

Parameters:

layerName - the name of the Layer.

Returns:

the Layer with the specified name. If no such Layer exists, return null.

 public int getNumberOfLayers()

Returns:

the number of Layers

 public void addProperty(ImprovProperty property)

Adds a property to the Actor

Parameters:

property - the property to be added.

 public ImprovProperty getProperty(String propertyName)

Gets an actor property given the property name

Parameters:

propertyName - the name of the property

Returns:

the property, if it exists, otherwise null.

All Packages  Class Hierarchy  This Package  Previous  Next  Index