com.threerings.opengl.model
Class Articulated

java.lang.Object
  com.threerings.expr.SimpleScope
      com.threerings.opengl.model.Model.Implementation
          com.threerings.opengl.model.Articulated

All Implemented Interfaces:

Scope, ScopeUpdateListener, Compositable, Enqueueable, Intersectable, Tickable

public class Articulated
extends Model.Implementation
implements Enqueueable

An articulated model implementation.

Nested Class Summary

static class	Articulated.MeshNode A node that contains a (visible and/or collision) mesh.
static class	Articulated.Node A node in the model.

Field Summary

Fields inherited from interface com.threerings.expr.Scope

EPOCH, NOW

Constructor Summary

Articulated(GlContext ctx, Scope parentScope, ArticulatedConfig config)
Creates a new articulated implementation.

Method Summary

void	attach(String point, Model model, boolean replace) Attaches the specified model at the given point.
void	composite() Adds this object's Dependencys and Enqueueables to the compositor in preparation for rendering.
Animation	createAnimation() Creates an animation for the model or returns null if not supported.
void	detach(Model model) Detaches an attached model.
void	detachAll(String point) Detaches any models attached to the specified point.
void	drawBounds() Draws the bounds of the model in immediate mode.
void	enqueue() Enqueues this object for rendering.
Animation	getAnimation(String name) Retrieves an animation by name.
Animation[]	getAnimations() Returns the model's list of animations.
Matrix4f	getBoneMatrix(String name) Returns a reference to the bone matrix for the named node.
Box	getBounds() Returns a reference to the bounds of the model.
int	getInfluenceFlags() Returns a set of flags indicating the types of influences that affect the model.
boolean	getIntersection(Ray3D ray, Vector3f result) Finds the intersection of a ray with this object and places it in the supplied vector (if it exists).
Articulated.Node	getNode(String name) Returns a reference to the node with the specified name.
List<Animation>	getPlayingAnimations() Returns a list of all animations currently playing.
Transform3D	getPointWorldTransform(String point) Returns a reference to the world transform of the given point.
SceneElement.TickPolicy	getTickPolicy() Returns the tick policy of the model.
boolean	hasCompleted() Determines whether the model (such as a transient effect) has completed.
void	reset() Resets the state of this model.
void	setConfig(ArticulatedConfig config) Sets the configuration of this model.
void	tick(float elapsed) Updates the state of this object based on the elapsed time in seconds.
void	updateBounds() Updates the bounds of the model.
void	wasAdded() Notes that the model was added to a scene.
void	willBeRemoved() Notes that the model will be removed from the scene.

Methods inherited from class com.threerings.opengl.model.Model.Implementation

getScopeName, isImplementation, setTickPolicy

Methods inherited from class com.threerings.expr.SimpleScope

addListener, dispose, get, getParentScope, removeListener, scopeUpdated

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Articulated

public Articulated(GlContext ctx,
                   Scope parentScope,
                   ArticulatedConfig config)

Creates a new articulated implementation.

Method Detail

setConfig

public void setConfig(ArticulatedConfig config)

Sets the configuration of this model.

getBoneMatrix

@Scoped
public Matrix4f getBoneMatrix(String name)

Returns a reference to the bone matrix for the named node.

getNode

@Scoped
public Articulated.Node getNode(String name)

Returns a reference to the node with the specified name.

enqueue

public void enqueue()

Description copied from interface: Enqueueable

Enqueues this object for rendering.

Specified by:

enqueue in interface Enqueueable

getPointWorldTransform

public Transform3D getPointWorldTransform(String point)

Description copied from class: Model.Implementation

Returns a reference to the world transform of the given point.

Overrides:

getPointWorldTransform in class Model.Implementation

attach

public void attach(String point,
                   Model model,
                   boolean replace)

Description copied from class: Model.Implementation

Attaches the specified model at the given point.

Overrides:

attach in class Model.Implementation

replace - if true, replace any existing attachments at the point.

detach

public void detach(Model model)

Description copied from class: Model.Implementation

Detaches an attached model.

Overrides:

detach in class Model.Implementation

detachAll

public void detachAll(String point)

Description copied from class: Model.Implementation

Detaches any models attached to the specified point.

Overrides:

detachAll in class Model.Implementation

getPlayingAnimations

public List<Animation> getPlayingAnimations()

Description copied from class: Model.Implementation

Returns a list of all animations currently playing.

Overrides:

getPlayingAnimations in class Model.Implementation

getAnimation

public Animation getAnimation(String name)

Description copied from class: Model.Implementation

Retrieves an animation by name.

Overrides:

getAnimation in class Model.Implementation

getAnimations

public Animation[] getAnimations()

Description copied from class: Model.Implementation

Returns the model's list of animations.

Overrides:

getAnimations in class Model.Implementation

createAnimation

public Animation createAnimation()

Description copied from class: Model.Implementation

Creates an animation for the model or returns null if not supported.

Overrides:

createAnimation in class Model.Implementation

hasCompleted

public boolean hasCompleted()

Description copied from class: Model.Implementation

Determines whether the model (such as a transient effect) has completed.

Overrides:

hasCompleted in class Model.Implementation

reset

public void reset()

Description copied from class: Model.Implementation

Resets the state of this model.

Overrides:

reset in class Model.Implementation

getInfluenceFlags

public int getInfluenceFlags()

Description copied from class: Model.Implementation

Returns a set of flags indicating the types of influences that affect the model.

Overrides:

getInfluenceFlags in class Model.Implementation

getBounds

public Box getBounds()

Description copied from class: Model.Implementation

Returns a reference to the bounds of the model.

Overrides:

getBounds in class Model.Implementation

updateBounds

public void updateBounds()

Description copied from class: Model.Implementation

Updates the bounds of the model.

Overrides:

updateBounds in class Model.Implementation

drawBounds

public void drawBounds()

Description copied from class: Model.Implementation

Draws the bounds of the model in immediate mode.

Overrides:

drawBounds in class Model.Implementation

getTickPolicy

public SceneElement.TickPolicy getTickPolicy()

Description copied from class: Model.Implementation

Returns the tick policy of the model.

Overrides:

getTickPolicy in class Model.Implementation

wasAdded

public void wasAdded()

Description copied from class: Model.Implementation

Notes that the model was added to a scene.

Overrides:

wasAdded in class Model.Implementation

willBeRemoved

public void willBeRemoved()

Description copied from class: Model.Implementation

Notes that the model will be removed from the scene.

Overrides:

willBeRemoved in class Model.Implementation

tick

public void tick(float elapsed)

Description copied from interface: Tickable

Updates the state of this object based on the elapsed time in seconds.

Specified by:

tick in interface Tickable

Overrides:

tick in class Model.Implementation

getIntersection

public boolean getIntersection(Ray3D ray,
                               Vector3f result)

Description copied from interface: Intersectable

Finds the intersection of a ray with this object and places it in the supplied vector (if it exists).

Specified by:

getIntersection in interface Intersectable

Overrides:

getIntersection in class Model.Implementation

Returns:

true if the ray intersected the object (in which case the result will contain the point of intersection), false otherwise.

composite

public void composite()

Description copied from interface: Compositable

Adds this object's Dependencys and Enqueueables to the compositor in preparation for rendering.

Specified by:

composite in interface Compositable

Overrides:

composite in class Model.Implementation