Articulated

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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
`protected Animation[]`	`_animations` The animations.
`protected HashMap<String,Animation>`	`_animationsByName` Maps animation names to animations.
`protected Box`	`_bounds` The bounds of the model.
`protected boolean`	`_completed` If true, the model has completed.
`protected ArticulatedConfig`	`_config` The model configuration.
`protected Model[]`	`_configAttachments` The attachments created from the configuration.
`protected GlContext`	`_ctx` The application context.
`protected int`	`_influenceFlags` Flags indicating which influences can affect the model.
`protected Transform3D`	`_localTransform` The local transform.
`protected Box`	`_nbounds` Holds the bounds of the model when updating.
`protected Articulated.Node[]`	`_nodes` The model nodes, in the order of a preorder depth-first traversal.
`protected HashMap<String,Articulated.Node>`	`_nodesByName` Maps node names to nodes.
`protected Function`	`_parentGetBoneMatrix` The parent implementation of `getBoneMatrix(java.lang.String)`.
`protected Transform3D`	`_parentViewTransform` The parent view transform.
`protected Transform3D`	`_parentWorldTransform` The parent world transform.
`protected ArrayList<Animation>`	`_playing` The animations currently being played, sorted by decreasing priority.
`protected Animation[]`	`_playingArray` Holds the playing animations during the tick.
`protected boolean`	`_started` Whether or not we have started the automatic animations.
`protected Surface[]`	`_surfaces` The skinned surfaces.
`protected SceneElement.TickPolicy`	`_tickPolicy` The model's tick policy.
`protected TransformState`	`_transformState` The shared transform state.
`protected int`	`_update` Incremented on each call to `updateTransforms()` and used to determine which nodes have been manipulated by animations on the current update.
`protected ArrayList<Model>`	`_userAttachments` User attachments (their parent scopes are the nodes to which they're attached).
`protected Transform3D`	`_viewTransform` The view transform.
`protected Transform3D`	`_worldTransform` The world transform.

Fields inherited from class com.threerings.expr.SimpleScope
`_parentScope`

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
`protected void`	`animationStarted(Animation animation, float overrideBlendOut)` Notes that an animation has started.
`protected void`	`animationStopped(Animation animation, boolean completed)` Notes that an animation has stopped.
`void`	`attach(String point, Model model, boolean replace)` Attaches the specified model at the given point.
`void`	`composite()` Adds this object's `Dependency`s and `Enqueueable`s 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.
`protected void`	`detachAll(Articulated.Node node)` Detaches all models attached to the specified node.
`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.
`protected Articulated.Node`	`getAttachmentNode(String name)` Returns a reference to the node with the specified name, logging a warning and returning `null` if no such node exists.
`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.
`protected boolean`	`getSkinIntersection(Ray3D ray, Vector3f result)` Checks for an intersection with the skin mesh.
`SceneElement.TickPolicy`	`getTickPolicy()` Returns the tick policy of the model.
`boolean`	`hasCompleted()` Determines whether the model (such as a transient effect) has completed.
`protected static SceneElement.TickPolicy`	`mergePolicy(SceneElement.TickPolicy policy, Model model)` Returns the policy covering both the current policy and that of the specified model.
`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.
`protected void`	`updateFromConfig()` Updates the model to match its new or modified configuration.
`protected void`	`updateTransforms()` Updates the node transforms based on the current animation state.
`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
`createSurface, createSurfaces, createSurfaces, getScopeName, isImplementation, setTickPolicy`

Methods inherited from class com.threerings.expr.SimpleScope
`addListener, dispose, get, getParentScope, removeListener, scopeUpdated`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

_ctx

protected GlContext _ctx

The application context.

_config

protected ArticulatedConfig _config

The model configuration.

_nodes

protected Articulated.Node[] _nodes

The model nodes, in the order of a preorder depth-first traversal.

_nodesByName

protected HashMap<String,Articulated.Node> _nodesByName

Maps node names to nodes.

_surfaces

protected Surface[] _surfaces

The skinned surfaces.

_animations

protected Animation[] _animations

The animations.

_animationsByName

protected HashMap<String,Animation> _animationsByName

Maps animation names to animations.

_configAttachments

protected Model[] _configAttachments

The attachments created from the configuration.

_parentWorldTransform

@Bound(value="worldTransform")
protected Transform3D _parentWorldTransform

The parent world transform.

_parentViewTransform

@Bound(value="viewTransform")
protected Transform3D _parentViewTransform

The parent view transform.

_parentGetBoneMatrix

@Bound(value="getBoneMatrix")
protected Function _parentGetBoneMatrix

The parent implementation of getBoneMatrix(java.lang.String).

_localTransform

@Bound
protected Transform3D _localTransform

The local transform.

_worldTransform

@Scoped
protected Transform3D _worldTransform

The world transform.

_viewTransform

@Scoped
protected Transform3D _viewTransform

The view transform.

_transformState

@Scoped
protected TransformState _transformState

The shared transform state.

_influenceFlags

protected int _influenceFlags

Flags indicating which influences can affect the model.

_bounds

@Scoped
protected Box _bounds

The bounds of the model.

_nbounds

@Scoped
protected Box _nbounds

Holds the bounds of the model when updating.

_tickPolicy

protected SceneElement.TickPolicy _tickPolicy

The model's tick policy.

_userAttachments

protected ArrayList<Model> _userAttachments

User attachments (their parent scopes are the nodes to which they're attached).

_started

protected boolean _started

Whether or not we have started the automatic animations.

_playing

protected ArrayList<Animation> _playing

The animations currently being played, sorted by decreasing priority.

_playingArray

protected Animation[] _playingArray

Holds the playing animations during the tick.

_update

protected int _update

Incremented on each call to updateTransforms() and used to determine which nodes have been manipulated by animations on the current update.

_completed

protected boolean _completed

If true, the model has completed.

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