com.openinventor.inventor.fields

Class SoSFEnum<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>

Direct Known Subclasses:

SoSFBitMask

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

Field containing an enumerated value. A single-value field that contains an enumerated type value, stored as an integer. Nodes that use this field class define mnemonic names for the values. 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.

SoSFEnums are written to file as a mnemonic enumerated type name. The name differs among uses of this field in various node or engine classes. See the reference pages for specific nodes or engines for the names (e.g. SoDrawStyle).

See also:

SoField, SoSField, SoMFEnum

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
SoSFEnum() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoSFEnum(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType, java.lang.Class<EnumType> enumClass, EnumType defaultValue) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getValue() Returns this field's value.
EnumType	getValue(java.lang.Class<EnumType> enumType)
long	getValueSize() Get size of the value.
void	setValue(EnumType newValue) Sets this field to newValue.
void	setValue(int newValue) Sets this field to newValue.
void	setValue(java.lang.String name) Sets this field to contain the given mnemonic name, passed in as a name or string.

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

SoSFEnum

@Deprecated
public SoSFEnum()

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

SoSFEnum

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

Default constructor.

Method Detail

getValue

public EnumType getValue(java.lang.Class<EnumType> enumType)

setValue

public void setValue(EnumType newValue)

Sets this field to newValue.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

setValue

public void setValue(java.lang.String name)

Sets this field to contain the given mnemonic name, passed in as a name or string.

getValueSize

public long getValueSize()

Get size of the value.

getValue

public int getValue()

Returns this field's value.

setValue

public void setValue(int newValue)

Sets this field to newValue.