net.java.joglutils.msg.elements
Class ViewingMatrixElement

java.lang.Object
  net.java.joglutils.msg.elements.Element
      net.java.joglutils.msg.elements.ViewingMatrixElement

Direct Known Subclasses:

GLViewingMatrixElement

public class ViewingMatrixElement
extends Element

Represents the viewing matrix, which contains the transformation between the camera and the model.

Field Summary

protected Mat4f

matrix

Constructor Summary

ViewingMatrixElement()

Method Summary

static void	enable(State defaultState) Enables this element in the passed state, which should be the default for a given action.
static ViewingMatrixElement	getInstance(State state) Returns the instance of this element in the passed State.
Mat4f	getMatrix() Returns the current viewing matrix; callers should not mutate this directly but instead use the accessor methods to change it.
StateIndex	getStateIndex() All concrete element subclasses must register themselves with the State in order to reserve a slot, or index, in the state.
static boolean	isEnabled(State state) Indicates whether this element is enabled in the given default state for a particular action.
Element	newInstance() Creates a new instance initialized to the default values for the state element.
void	push(State state) Pushes the element, allowing for side effects to occur.
static void	set(State state, Mat4f matrix) Sets the viewing matrix in the given state to the given one.
void	setElt(Mat4f matrix) Sets the viewing matrix in this element to the given one.

Methods inherited from class net.java.joglutils.msg.elements.Element

getDepth, getNext, getNextInStack, pop, setDepth, setNext, setNextInStack

Methods inherited from class java.lang.Object

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

Field Detail

matrix

protected Mat4f matrix

Constructor Detail

ViewingMatrixElement

public ViewingMatrixElement()

Method Detail

getStateIndex

public StateIndex getStateIndex()

Description copied from class: Element

All concrete element subclasses must register themselves with the State in order to reserve a slot, or index, in the state. This method must be overridden to return this slot.

Specified by:

getStateIndex in class Element

newInstance

public Element newInstance()

Description copied from class: Element

Creates a new instance initialized to the default values for the state element. All concrete Element subclasses must implement this operation.

Specified by:

newInstance in class Element

getInstance

public static ViewingMatrixElement getInstance(State state)

Returns the instance of this element in the passed State.

enable

public static void enable(State defaultState)

Enables this element in the passed state, which should be the default for a given action.

isEnabled

public static boolean isEnabled(State state)

Indicates whether this element is enabled in the given default state for a particular action.

getMatrix

public Mat4f getMatrix()

Returns the current viewing matrix; callers should not mutate this directly but instead use the accessor methods to change it.

push

public void push(State state)

Description copied from class: Element

Pushes the element, allowing for side effects to occur. Default method does nothing.

Overrides:

push in class Element

set

public static void set(State state,
                       Mat4f matrix)

Sets the viewing matrix in the given state to the given one.

setElt

public void setElt(Mat4f matrix)

Sets the viewing matrix in this element to the given one.