SimpleSceneElement

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.scene
Class SimpleSceneElement

java.lang.Object
  com.threerings.opengl.util.SimpleRenderable
      com.threerings.opengl.util.SimpleTransformable
          com.threerings.opengl.scene.SimpleSceneElement

All Implemented Interfaces:: Compositable, Enqueueable, SceneElement, SceneObject, Intersectable, Tickable

Direct Known Subclasses:: AreaElement, RectangleElement, ShapeConfigElement, ShapeSceneElement, TextBillboard

public abstract class SimpleSceneElement
extends SimpleTransformable
implements SceneElement
extends SimpleTransformable
implements SceneElement

Extends SimpleTransformable and provides a basic implementation of the SceneElement interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.threerings.opengl.scene.SceneElement
`SceneElement.TickPolicy`

Field Summary
`protected Box`	`_bounds` The bounds of the element.
`protected SceneInfluenceSet`	`_influences` The influences affecting the element.
`protected int`	`_lastVisit` The visitation id of the last visit.
`protected Box`	`_nbounds` Holds the new bounds of the element when updating.
`protected Scene`	`_scene` The scene to which this element has been added.
`protected SceneElement.TickPolicy`	`_tickPolicy` The element's tick policy.
`protected Object`	`_userObject` The element's user object.

Fields inherited from class com.threerings.opengl.util.SimpleTransformable
`_transform`

Fields inherited from class com.threerings.opengl.util.SimpleRenderable
`_batch, _ctx, _priority, _queue`

Constructor Summary
`SimpleSceneElement(GlContext ctx)` Creates a new scene element.
`SimpleSceneElement(GlContext ctx, String queue)` Creates a new simple scene element.
`SimpleSceneElement(GlContext ctx, String queue, int priority)` Creates a new simple scene element.
`SimpleSceneElement(GlContext ctx, String queue, int priority, boolean modifiesColorState, int primitiveCount)` Creates a new simple scene element.

Method Summary
`protected void`	`boundsDidChange()` Notes that the bounds have changed.
`protected void`	`boundsWillChange()` Notes that the bounds are about to change.
`protected void`	`computeBounds(Box result)` Computes the bounds of the element and places them in the provided result object.
`Box`	`getBounds()` Returns a reference to the bounds of the object.
`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).
`protected Box`	`getLocalBounds()` Returns the local bounds of the element.
`SceneElement.TickPolicy`	`getTickPolicy()` Returns the policy that determines when the `Tickable.tick(float)` method must be called.
`Object`	`getUserObject()` Returns this element's user object reference.
`void`	`setInfluences(SceneInfluenceSet influences)` Sets the influences affecting this element.
`void`	`setTickPolicy(SceneElement.TickPolicy policy)` Sets the element's tick policy.
`void`	`setTransform(Transform3D transform)` Sets the transform to the specified value and promotes it to `Transform3D.UNIFORM`, then updates the bounds of the element.
`void`	`setUserObject(Object object)` Sets the element's user object reference.
`void`	`tick(float elapsed)` Updates the state of this object based on the elapsed time in seconds.
`void`	`updateBounds()` Updates the bounds of the element.
`boolean`	`updateLastVisit(int visit)` Checks and updates the last visit value.
`void`	`wasAdded(Scene scene)` Notes that the element was added to the specified scene.
`void`	`willBeRemoved()` Notes that the element will be removed from the scene.

Methods inherited from class com.threerings.opengl.util.SimpleTransformable
`createStates, enqueue, getCenter, getTransform`

Methods inherited from class com.threerings.opengl.util.SimpleRenderable
`composite, createBatch, draw, getStates`

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

Methods inherited from interface com.threerings.opengl.compositor.Compositable
`composite`

Field Detail

_bounds

protected Box _bounds

The bounds of the element.

_nbounds

protected Box _nbounds

Holds the new bounds of the element when updating.

_tickPolicy

protected SceneElement.TickPolicy _tickPolicy

The element's tick policy.

_userObject

protected Object _userObject

The element's user object.

_scene

protected Scene _scene

The scene to which this element has been added.

_influences

protected SceneInfluenceSet _influences

The influences affecting the element.

_lastVisit

protected int _lastVisit

The visitation id of the last visit.

Constructor Detail

SimpleSceneElement

public SimpleSceneElement(GlContext ctx)

Creates a new scene element.

SimpleSceneElement

public SimpleSceneElement(GlContext ctx,
                          String queue)

Creates a new simple scene element.

Parameters:: queue - the name of the queue into which we place the batch.

SimpleSceneElement

public SimpleSceneElement(GlContext ctx,
                          String queue,
                          int priority)

Creates a new simple scene element.

Parameters:: queue - the name of the queue into which we place the batch.; priority - the priority level at which to enqueue the batch.

SimpleSceneElement

public SimpleSceneElement(GlContext ctx,
                          String queue,
                          int priority,
                          boolean modifiesColorState,
                          int primitiveCount)

Creates a new simple scene element.

Parameters:: queue - the name of the queue into which we place the batch.; priority - the priority level at which to enqueue the batch.; modifiesColorState - if true, invalidate the color state after calling the SimpleRenderable.draw() method.; primitiveCount - the primitive count to report to the renderer.

Method Detail

setTickPolicy

public void setTickPolicy(SceneElement.TickPolicy policy)

Sets the element's tick policy.

setUserObject

public void setUserObject(Object object)

Sets the element's user object reference.

setTransform

public void setTransform(Transform3D transform)

Sets the transform to the specified value and promotes it to Transform3D.UNIFORM, then updates the bounds of the element.

updateBounds

public void updateBounds()

Updates the bounds of the element. The default implementation transforms the bounds returned by getLocalBounds().