WildMagic.LibGraphics.Rendering

Class PolygonOffsetState

java.lang.Object

WildMagic.LibGraphics.ObjectSystem.GraphicsObject

WildMagic.LibGraphics.Rendering.GlobalState

WildMagic.LibGraphics.Rendering.PolygonOffsetState

All Implemented Interfaces:

Serializable, StreamInterface

public class PolygonOffsetState
extends GlobalState
implements StreamInterface, Serializable

See Also:

Serialized Form

Nested Class Summary

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

GlobalState.StateType

Field Summary

Fields

Modifier and Type	Field and Description
float	Bias The offset is Scale*dZ + Bias*r where dZ is the change in depth relative to the screen space area of the poly, and r is the smallest resolvable depth difference.
boolean	FillEnabled Set whether offset should be enabled for the various polygon drawing modes (fill, line, point).
boolean	LineEnabled Set whether offset should be enabled for the various polygon drawing modes (fill, line, point).
boolean	PointEnabled Set whether offset should be enabled for the various polygon drawing modes (fill, line, point).
float	Scale The offset is Scale*dZ + Bias*r where dZ is the change in depth relative to the screen space area of the poly, and r is the smallest resolvable depth difference.
private static long	serialVersionUID

Fields inherited from class WildMagic.LibGraphics.Rendering.GlobalState

Default, DefaultInitialized

Constructor Summary

Constructors

Constructor and Description
PolygonOffsetState() Default constructor.

Method Summary

Methods

Modifier and Type	Method and 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(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

FillEnabled

public boolean FillEnabled

Set whether offset should be enabled for the various polygon drawing modes (fill, line, point).

LineEnabled

public boolean LineEnabled

Set whether offset should be enabled for the various polygon drawing modes (fill, line, point).

PointEnabled

public boolean PointEnabled

Set whether offset should be enabled for the various polygon drawing modes (fill, line, point).

Scale

public float Scale

The offset is Scale*dZ + Bias*r where dZ is the change in depth relative to the screen space area of the poly, and r is the smallest resolvable depth difference. Negative values move polygons closer to the eye.

Bias

public float Bias

The offset is Scale*dZ + Bias*r where dZ is the change in depth relative to the screen space area of the poly, and r is the smallest resolvable depth difference. Negative values move polygons closer to the eye.

Constructor Detail

PolygonOffsetState

public PolygonOffsetState()

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.POLYGONOFFSET;

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(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.