WildMagic.LibGraphics.Effects

Class PlanarReflectionEffect

java.lang.Object

WildMagic.LibGraphics.ObjectSystem.GraphicsObject

WildMagic.LibGraphics.Effects.Effect

WildMagic.LibGraphics.Effects.PlanarReflectionEffect

All Implemented Interfaces:

Serializable, NameIdInterface, StreamInterface

public class PlanarReflectionEffect
extends Effect
implements NameIdInterface, StreamInterface, Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected float[]	m_afReflectance Reflectance factors
protected TriMesh[]	m_aspkPlane Reflection planes
protected int	m_iQuantity Number of reflection planes
protected AlphaState	m_spkAState Temporary render state for drawing.
protected StencilState	m_spkSState Temporary render state for drawing.
protected ZBufferState	m_spkZState Temporary render state for drawing.
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
PlanarReflectionEffect() Streaming constructor
PlanarReflectionEffect(int iQuantity) Creates a new PlanarReflectionEffect for the number of planes specified.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Delete data members:
void	Draw(Renderer pkRenderer, Spatial pkGlobalObject, int iMin, int iMax, VisibleObject[] akVisible) Draw the planar reflections
void	GetAllObjectsByName(String rkName, Vector<GraphicsObject> rkObjects) Writes all GraphicsObjects with the name that matches the input parameter, rkName into the Vector parameter rkObjects.
int	GetDiskUsed(StreamVersion rkVersion) Returns the size of this object and it's children on disk for the current StreamVersion parameter.
GraphicsObject	GetObjectByID(int uiID) Returns the GraphicsObject with the ID that matches the input parameter, uiID.
GraphicsObject	GetObjectByName(String rkName) Returns the GraphicsObject with the name that matches the input parameter, rkName.
TriMesh	GetPlane(int i) Returns the ith reflection plane
int	GetQuantity() Return the number of reflection planes
float	GetReflectance(int i) Returns the reflectance for the ith reflection plane
protected void	GetReflectionMatrixAndPlane(int i, Matrix4f rkReflection, Plane3f rkPlane) Computes and returns the reflection matrix for the ith plane in world coordinates.
void	Link(Stream rkStream, Stream.Link pkLink) Copies this objects children objects from the input Stream's HashTable, based on the LinkID of the child stored in the pkLink parameter.
void	Load(Stream rkStream, Stream.Link pkLink) Loads this object from the input parameter rkStream, using the input Stream.Link to store the IDs of children objects of this object for linking after all objects are loaded from the Stream.
boolean	Register(Stream rkStream) Registers this object with the input Stream parameter.
void	Save(Stream rkStream) Write this object and all it's children to the Stream.
StringTree	SaveStrings(String acTitle) Write this object into a StringTree for the scene-graph visualization.
void	SetPlane(int i, TriMesh spkPlane) Sets the ith reflection plane
void	SetReflectance(int i, float fReflectance) Sets the reflectance for the ith reflection plane

Methods inherited from class WildMagic.LibGraphics.Effects.Effect

LoadResources, ReleaseResources

Methods inherited from class WildMagic.LibGraphics.ObjectSystem.GraphicsObject

GetID, GetName, GetNextID, GetObjectByIDBase, GetObjectByNameBase, SetName

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

m_iQuantity

protected int m_iQuantity

Number of reflection planes

m_aspkPlane

protected TriMesh[] m_aspkPlane

Reflection planes

m_afReflectance

protected float[] m_afReflectance

Reflectance factors

m_spkAState

protected AlphaState m_spkAState

Temporary render state for drawing.

m_spkSState

protected StencilState m_spkSState

Temporary render state for drawing.

m_spkZState

protected ZBufferState m_spkZState

Temporary render state for drawing.

Constructor Detail

PlanarReflectionEffect

public PlanarReflectionEffect()

Streaming constructor

PlanarReflectionEffect

public PlanarReflectionEffect(int iQuantity)

Creates a new PlanarReflectionEffect for the number of planes specified.

Parameters:

iQuantity - the number of reflection planes.

Method Detail

dispose

public void dispose()

Delete data members:

Overrides:

dispose in class GraphicsObject

Draw

public void Draw(Renderer pkRenderer,
        Spatial pkGlobalObject,
        int iMin,
        int iMax,
        VisibleObject[] akVisible)

Draw the planar reflections

Overrides:

Draw in class Effect

Parameters:

pkRenderer - the Renderer object.

pkGlobalObject - the base scene-graph object.

iMin - the first VisibleObject to draw

iMax - the last VisibleObject to draw

akVisible - the list VisibleObjects to draw

GetAllObjectsByName

public void GetAllObjectsByName(String rkName,
                       Vector<GraphicsObject> rkObjects)

Writes all GraphicsObjects with the name that matches the input parameter, rkName into the Vector parameter rkObjects.

Specified by:

GetAllObjectsByName in interface NameIdInterface

Overrides:

GetAllObjectsByName in class GraphicsObject

Parameters:

rkName - the name of the objects to return.

rkObjects - a Vector of all objects with the matching name.

GetDiskUsed

public int GetDiskUsed(StreamVersion rkVersion)

Returns the size of this object and it's children on disk for the current StreamVersion parameter.

Specified by:

GetDiskUsed in interface StreamInterface

Overrides:

GetDiskUsed in class Effect

Parameters:

rkVersion - the current version of the Stream file being created.

Returns:

the size of this object on disk.

GetObjectByID

public GraphicsObject GetObjectByID(int uiID)

Returns the GraphicsObject with the ID that matches the input parameter, uiID.

Specified by:

GetObjectByID in interface NameIdInterface

Overrides:

GetObjectByID in class GraphicsObject

Parameters:

uiID - the ID of the object to return.

Returns:

the GraphicsObject that matches the input name.

GetObjectByName

public GraphicsObject GetObjectByName(String rkName)

Returns the GraphicsObject with the name that matches the input parameter, rkName.

Specified by:

GetObjectByName in interface NameIdInterface

Overrides:

GetObjectByName in class GraphicsObject

Parameters:

rkName - the name of the object to return.

Returns:

the GraphicsObject that matches the input name.

GetPlane

public TriMesh GetPlane(int i)

Returns the ith reflection plane

Parameters:

i - the ith reflection plane

Returns:

the ith reflection plane

GetQuantity

public int GetQuantity()

Return the number of reflection planes

Returns:

the number of reflection planes

GetReflectance

public float GetReflectance(int i)

Returns the reflectance for the ith reflection plane

Parameters:

i - the ith reflection plane

Returns:

the reflectance parameter

Link

public void Link(Stream rkStream,
        Stream.Link pkLink)

Copies this objects children objects from the input Stream's HashTable, based on the LinkID of the child stored in the pkLink parameter.

Specified by:

Link in interface StreamInterface

Overrides:

Link in class Effect

Parameters:

rkStream - the Stream where the child objects are stored.

pkLink - the Link class from which the child object IDs are read.

Load

public void Load(Stream rkStream,
        Stream.Link pkLink)

Loads this object from the input parameter rkStream, using the input Stream.Link to store the IDs of children objects of this object for linking after all objects are loaded from the Stream.

Specified by:

Load in interface StreamInterface

Overrides:

Load in class Effect

Parameters:

rkStream - the Stream from which this object is being read.

pkLink - the Link class for storing the IDs of this object's children objects.

Register

public boolean Register(Stream rkStream)

Registers this object with the input Stream parameter. All objects streamed to disk are registered with the Stream so that a unique list of objects is maintained.

Specified by:

Register in interface StreamInterface

Overrides:

Register in class Effect

Parameters:

rkStream - the Stream where the child objects are stored.

Returns:

true if this object is registered, false if the object has already been registered.

Save

public void Save(Stream rkStream)

Write this object and all it's children to the Stream.

Specified by:

Save in interface StreamInterface

Overrides:

Save in class Effect

Parameters:

rkStream - the Stream where the child objects are stored.

SaveStrings

public StringTree SaveStrings(String acTitle)

Write this object into a StringTree for the scene-graph visualization.

Specified by:

SaveStrings in interface StreamInterface

Overrides:

SaveStrings in class Effect

Parameters:

acTitle - the header for this object in the StringTree.

Returns:

StringTree containing a String-based representation of this object and it's children.

SetPlane

public void SetPlane(int i,
            TriMesh spkPlane)

Sets the ith reflection plane

Parameters:

i - the ith reflection plane to set

spkPlane - the reflection plane

SetReflectance

public void SetReflectance(int i,
                  float fReflectance)

Sets the reflectance for the ith reflection plane

Parameters:

i - the ith reflection plane

fReflectance - the reflectance parameter

GetReflectionMatrixAndPlane

protected void GetReflectionMatrixAndPlane(int i,
                               Matrix4f rkReflection,
                               Plane3f rkPlane)

Computes and returns the reflection matrix for the ith plane in world coordinates.

Parameters:

i - the ith reflection plane

rkReflection - returned value of the reflection matrix

rkPlane - returned value of the plane in world coordinates.