|
Aviatrix3D 2.1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.j3d.aviatrix3d.SceneGraphObject
org.j3d.aviatrix3d.NodeComponent
org.j3d.aviatrix3d.StencilAttributes
public class StencilAttributes
Describes attributes used when interacting with the stencil buffer.
Including this state class in the global setup automatically enables stencil testing and the stencil buffer.
The default setup for this class is:
Internationalisation Resource Names
Field Summary | |
---|---|
static int |
FUNCTION_ALWAYS
Comparison function that always passes. |
static int |
FUNCTION_EQUAL
Comparison function that passes if (ref & mask) == (stencil & mask). |
static int |
FUNCTION_GREATER
Comparison function that passes if (ref & mask) > (stencil & mask). |
static int |
FUNCTION_GREATER_OR_EQUAL
Comparison function that passes if (ref & mask) >= (stencil & mask). |
static int |
FUNCTION_LESS
Comparison function that passes if (ref & mask) < (stencil & mask). |
static int |
FUNCTION_LESS_OR_EQUAL
Comparison function that passes if (ref & mask) <= (stencil & mask). |
static int |
FUNCTION_NEVER
Comparison function that always fails. |
static int |
FUNCTION_NOTEQUAL
Comparison function that passes if (ref & mask) not equal to (stencil & mask). |
static short |
STENCIL_DECREMENT
When the stencil function matches, decrement the stencil value. |
static short |
STENCIL_INCREMENT
When the stencil function matches, increment the stencil value. |
static short |
STENCIL_INVERT
When the stencil function matches, bitwise invert the stencil value. |
static short |
STENCIL_KEEP
When the stencil function matches, keep the current stencil value. |
static short |
STENCIL_REPLACE
When the stencil function matches, set the stencil value to the reference value. |
static short |
STENCIL_ZERO
When the stencil function matches, set the stencil value to zero. |
Fields inherited from class org.j3d.aviatrix3d.NodeComponent |
---|
lastParent, liveCount, parentList |
Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject |
---|
alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler |
Fields inherited from interface org.j3d.aviatrix3d.rendering.AppearanceAttributeRenderable |
---|
ALPHA_ATTRIBUTE, BLEND_ATTRIBUTE, DEPTH_ATTRIBUTE, LINE_ATTRIBUTE, POINT_ATTRIBUTE, POLYGON_ATTRIBUTE, STENCIL_ATTRIBUTE |
Constructor Summary | |
---|---|
StencilAttributes()
Constructs a state set with default values. |
Method Summary | |
---|---|
int |
compareTo(java.lang.Object o)
Compares this object with the specified object for order. |
int |
compareTo(StencilAttributes sbs)
Compares this object with the specified object for order. |
boolean |
equals(java.lang.Object o)
Compare this object for equality to the given object. |
boolean |
equals(StencilAttributes sbs)
Compares this object with the specified object to check for equivalence. |
int |
getAttributeType()
Get the type this visual attribute represents. |
int |
getDepthFailOperation()
Get the current operation used when the stencil test passes, but depth test fails. |
int |
getDepthPassOperation()
Get the current operation used when the stencil and depth tests pass. |
int |
getFunctionCompareMask()
Get the current function comparison mask. |
int |
getFunctionReferenceValue()
Get the current stencil reference value for use in the stencil function setup. |
int |
getStencilFailOperation()
Get the current function comparison mask. |
int |
getStencilFunction()
Get the function type used when the stencil and depth tests pass. |
int |
getStencilWriteMask()
Get the current write mask. |
void |
postRender(javax.media.opengl.GL gl)
Restore all openGL state to the given drawable. |
void |
render(javax.media.opengl.GL gl)
Issue ogl commands needed for this component |
void |
setDepthFailOperation(int op)
Set the operation that should be performed if the stencil test passes but the depth test fails. |
void |
setDepthPassOperation(int op)
Set the operation that should be performed if the stencil and depth tests pass. |
void |
setFunctionCompareMask(int mask)
Set the bitmask used for the stencil comparison operation. |
void |
setFunctionReferenceValue(int value)
Set the reference value used for the stencil comparison operation. |
void |
setStencilFailOperation(int op)
Set the operation that should be performed if the stencil test fails. |
void |
setStencilFunction(int func)
Set the operation that should be performed if the stencil and depth tests pass. |
void |
setStencilWriteMask(int mask)
Set the bitmask used for the stencil write operation. |
Methods inherited from class org.j3d.aviatrix3d.NodeComponent |
---|
addParent, getParents, numParents, removeParent |
Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject |
---|
checkForCyclicChild, checkForCyclicParent, dataChanged, getAppUpdateWriteTimingMessage, getBoundsWriteTimingMessage, getDataWriteTimingMessage, getUserData, isLive, setLive, setUpdateHandler, setUserData |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final short STENCIL_INCREMENT
public static final short STENCIL_DECREMENT
public static final short STENCIL_KEEP
public static final short STENCIL_INVERT
public static final short STENCIL_ZERO
public static final short STENCIL_REPLACE
public static final int FUNCTION_NEVER
public static final int FUNCTION_LESS
public static final int FUNCTION_LESS_OR_EQUAL
public static final int FUNCTION_GREATER
public static final int FUNCTION_GREATER_OR_EQUAL
public static final int FUNCTION_EQUAL
public static final int FUNCTION_NOTEQUAL
public static final int FUNCTION_ALWAYS
Constructor Detail |
---|
public StencilAttributes()
Method Detail |
---|
public int getAttributeType()
getAttributeType
in interface AppearanceAttributeRenderable
public void render(javax.media.opengl.GL gl)
render
in interface ObjectRenderable
gl
- The gl context to draw withpublic void postRender(javax.media.opengl.GL gl)
postRender
in interface ObjectRenderable
gl
- The gl context to draw withpublic int compareTo(java.lang.Object o) throws java.lang.ClassCastException
compareTo
in interface java.lang.Comparable
o
- The objec to be compared
java.lang.ClassCastException
- The specified object's type prevents it from
being compared to this Objectpublic boolean equals(java.lang.Object o)
equals
in interface Renderable
equals
in class java.lang.Object
o
- The object to be compared
public void setFunctionCompareMask(int mask) throws InvalidWriteTimingException
mask
- The bit mask of planes to compare
InvalidWriteTimingException
- An attempt was made to write outside
of the NodeUpdateListener data changed callback methodpublic int getFunctionCompareMask()
public void setStencilWriteMask(int mask) throws InvalidWriteTimingException
mask
- The bit mask of planes to write when operations succeed
InvalidWriteTimingException
- An attempt was made to write outside
of the NodeUpdateListener data changed callback methodpublic int getStencilWriteMask()
public void setFunctionReferenceValue(int value) throws InvalidWriteTimingException
value
- A value to compare for the depth testing
InvalidWriteTimingException
- An attempt was made to write outside
of the NodeUpdateListener data changed callback methodpublic int getFunctionReferenceValue()
public void setStencilFailOperation(int op) throws java.lang.IllegalArgumentException, InvalidWriteTimingException
op
- One of the STENCIL_ constants
InvalidWriteTimingException
- An attempt was made to write outside
of the NodeUpdateListener data changed callback method
java.lang.IllegalArgumentException
- The operation value was not one of the
valid types.public int getStencilFailOperation()
public void setDepthFailOperation(int op) throws java.lang.IllegalArgumentException, InvalidWriteTimingException
op
- One of the STENCIL_ constants
InvalidWriteTimingException
- An attempt was made to write outside
of the NodeUpdateListener data changed callback method
java.lang.IllegalArgumentException
- The operation value was not one of the
valid types.public int getDepthFailOperation()
public void setDepthPassOperation(int op) throws java.lang.IllegalArgumentException, InvalidWriteTimingException
op
- One of the STENCIL_ constants
InvalidWriteTimingException
- An attempt was made to write outside
of the NodeUpdateListener data changed callback method
java.lang.IllegalArgumentException
- The operation value was not one of the
valid types.public int getDepthPassOperation()
public void setStencilFunction(int func) throws java.lang.IllegalArgumentException, InvalidWriteTimingException
func
- One of the FUNCTION_ constants
InvalidWriteTimingException
- An attempt was made to write outside
of the NodeUpdateListener data changed callback method
java.lang.IllegalArgumentException
- The operation value was not one of the
valid types.public int getStencilFunction()
public int compareTo(StencilAttributes sbs)
sbs
- The attributes instance to be comsbsred
public boolean equals(StencilAttributes sbs)
sbs
- The attributes instance to be compared
|
Aviatrix3D 2.1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |