Package com.openinventor.inventor.nodes

Class SoColorMask

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoColorMask

All Implemented Interfaces:

SafeDisposable

public class SoColorMask
extends SoNode

Enable and disable writing of frame buffer color components. Specifies whether individual color components in the frame buffer will be modified during rendering.

The color mask will affect all draw buffers.

"Hidden Line Rendering" is a typical use case where a SoColorMask can be useful: faces are first rendered with red, green, blue and alpha masks to false, so that only depth is written. Then, the shape is rendered in wireframe mode, with all masks to true.

To control modifying the depth buffer during rendering see SoDepthBuffer.

File format/default:

ColorMask {

red	true
green	true
blue	true
alpha	true

}

Since:

Open Inventor 10.4

See Also:

• SoDrawStyle
• SoDepthBuffer

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoNode

SoNode.RenderModes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field	Description
final SoSFBool	alpha	Specifies whether or not the alpha component can be written into the frame buffer.
final SoSFBool	blue	Specifies whether or not the blue component can be written into the frame buffer.
final SoSFBool	green	Specifies whether or not the green component can be written into the frame buffer.
final SoSFBool	red	Specifies whether or not the red component can be written into the frame buffer.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor	Description
SoColorMask()

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

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

Field Details

red

public final SoSFBool red

Specifies whether or not the red component can be written into the frame buffer. The default value is true, indicating that the color component can be written.

green

public final SoSFBool green

Specifies whether or not the green component can be written into the frame buffer. The default value is true, indicating that the color component can be written.

blue

public final SoSFBool blue

Specifies whether or not the blue component can be written into the frame buffer. The default value is true, indicating that the color component can be written.

alpha

public final SoSFBool alpha

Specifies whether or not the alpha component can be written into the frame buffer. The default value is true, indicating that the color component can be written.

Constructor Details

SoColorMask

public SoColorMask()