Package WildMagic.LibGraphics.Rendering

Class StencilState

java.lang.Object

WildMagic.LibGraphics.ObjectSystem.GraphicsObject

WildMagic.LibGraphics.Rendering.GlobalState

WildMagic.LibGraphics.Rendering.StencilState

All Implemented Interfaces:

java.io.Serializable, StreamInterface

public class StencilState
extends GlobalState
implements StreamInterface, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StencilState.CompareFunction	Stencil compare function.
static class	StencilState.OperationType	Stencil operation type.

Nested classes/interfaces inherited from class WildMagic.LibGraphics.Rendering.GlobalState

GlobalState.StateType

Field Summary

Fields

Modifier and Type	Field	Description
StencilState.CompareFunction	Compare	Compare function default: CF_NEVER
boolean	Enabled	Enabled default: false
int	Mask	Mask default: ~0
private static StencilState.CompareFunction	ms_eCompareFunctionStatic	Initializes static enum for compare function.
private static StencilState.OperationType	ms_eOperationTypeStatic	Initializes static enum for operation type.
private static java.util.HashMap<java.lang.Integer,StencilState.CompareFunction>	ms_pkCompareFunctionMap	Maps compare function enum to int values.
private static java.util.HashMap<java.lang.Integer,StencilState.OperationType>	ms_pkOperationTypeMap	Maps operation type enum to int values.
StencilState.OperationType	OnFail	OnFail default: OT_KEEP
StencilState.OperationType	OnZFail	OnZFail default: OT_KEEP
StencilState.OperationType	OnZPass	OnZPass default: OT_KEEP
int	Reference	Renference default: 0
private static long	serialVersionUID
int	WriteMask	Write Mask default: ~0

Fields inherited from class WildMagic.LibGraphics.Rendering.GlobalState

Default, DefaultInitialized

Constructor Summary

Constructors

Constructor	Description
StencilState()	Default constructor.

Method Summary

Modifier and Type	Method	Description
int	GetDiskUsed(StreamVersion rkVersion)	Returns the size of this object and it's children on disk for the current StreamVersion parameter.
GlobalState.StateType	GetStateType()	Return type.
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.
void	Save(Stream rkStream)	Write this object and all it's children to the Stream.
StringTree	SaveStrings(java.lang.String acTitle)	Write this object into a StringTree for the scene-graph visualization.

Methods inherited from class WildMagic.LibGraphics.ObjectSystem.GraphicsObject

dispose, GetAllObjectsByName, GetID, GetName, GetNextID, GetObjectByID, GetObjectByIDBase, GetObjectByName, GetObjectByNameBase, Link, Register, SetName

Methods inherited from class java.lang.Object

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

Methods inherited from interface WildMagic.LibGraphics.ObjectSystem.StreamInterface

Link, Register

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

ms_pkCompareFunctionMap

private static java.util.HashMap<java.lang.Integer,StencilState.CompareFunction> ms_pkCompareFunctionMap

Maps compare function enum to int values.

ms_pkOperationTypeMap

private static java.util.HashMap<java.lang.Integer,StencilState.OperationType> ms_pkOperationTypeMap

Maps operation type enum to int values.

ms_eCompareFunctionStatic

private static StencilState.CompareFunction ms_eCompareFunctionStatic

Initializes static enum for compare function.

ms_eOperationTypeStatic

private static StencilState.OperationType ms_eOperationTypeStatic

Initializes static enum for operation type.

Enabled

public boolean Enabled

Enabled default: false

Compare

public StencilState.CompareFunction Compare

Compare function default: CF_NEVER

Reference

public int Reference

Renference default: 0

Mask

public int Mask

Mask default: ~0

WriteMask

public int WriteMask

Write Mask default: ~0

OnFail

public StencilState.OperationType OnFail

OnFail default: OT_KEEP

OnZFail

public StencilState.OperationType OnZFail

OnZFail default: OT_KEEP

OnZPass

public StencilState.OperationType OnZPass

OnZPass default: OT_KEEP

Constructor Detail

StencilState

public StencilState()

Default constructor.

Method Detail

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 GraphicsObject

Parameters:

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

Returns:

the size of this object on disk.

GetStateType

public final GlobalState.StateType GetStateType()

Return type.

Specified by:

GetStateType in class GlobalState

Returns:

StateType.STENCIL;

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 GraphicsObject

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.

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 GraphicsObject

Parameters:

rkStream - the Stream where the child objects are stored.

SaveStrings

public StringTree SaveStrings(java.lang.String acTitle)

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

Specified by:

SaveStrings in interface StreamInterface

Overrides:

SaveStrings in class GlobalState

Parameters:

acTitle - the header for this object in the StringTree.

Returns:

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