com.openinventor.inventor.fields

Class SoSFBitMask<EnumType extends java.lang.Enum<EnumType> & IntegerValuedEnum>

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoSField

com.openinventor.inventor.fields.SoSFEnum<EnumType>

com.openinventor.inventor.fields.SoSFBitMask<EnumType>

public class SoSFBitMask<EnumType extends java.lang.Enum<EnumType> & IntegerValuedEnum>
extends SoSFEnum<EnumType>

Single-value field containing a set of bit flags. A single-value field that contains a mask of bit flags, stored as an integer. Nodes that use this field class define mnemonic names for the bit flags. These names should be used when setting or testing the values of the field, even though the values are treated as integers in the methods.

The bit-wise "&" and "|" operators should be used when testing and setting flags in a mask. For example:

 // Add sides to the set of parts rendered
 text.parts.setValue( text.parts.getValue() | SoText3.PartType.SIDES.getValue() );
 
 // Remove sides from the set of parts rendered
 text.parts.setValue( text.parts.getValue() & ~SoText3.PartType.SIDES.getValue() );

SoSFBitMasks are written to file as one or more mnemonic enumerated type names, in this format:

 ( flag1 | flag2 | ... )

If only one flag is used in a mask, the parentheses are optional. These names differ among uses of this field in various node or engine classes. See their reference pages for the names.

The field values may also be represented as integers, but this is not guaranteed to be portable.

See also:

SoField, SoSField, SoMFBitMask

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.fields.SoField

SoField.FieldTypes

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

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoSFBitMask() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoSFBitMask(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType, java.lang.Class<EnumType> enumClass, EnumType defaultValue) Default constructor.

Method Summary

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

equals, getValue, getValue, getValueSize, setValue, setValue, setValue

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

appendConnection, appendConnection, appendConnection, connectFrom, connectFrom, connectFrom, disconnect, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getConnectedVRMLInterp, getContainer, getNumConnections, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Constructor Detail

SoSFBitMask

@Deprecated
public SoSFBitMask()

Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.

SoSFBitMask

public SoSFBitMask(SoFieldContainer fieldContainer,
                   java.lang.String fieldName,
                   SoField.FieldTypes fieldType,
                   java.lang.Class<EnumType> enumClass,
                   EnumType defaultValue)

Default constructor.