man SoSFEnum () - field containing an enumerated value

NAME

SoSFEnum - field containing an enumerated value

INHERITS FROM

SoField > SoSField > SoSFEnum

SYNOPSIS

Methods from class SoSFEnum: c } c } setValue(const SbName &name)

c } c } getClassTypeId()

c } c } getTypeId() const

c } c } getValue() const

c } c } operator =(int newValue)

c } c } setValue(int newValue)

c } c } operator ==(const SoSFEnum &f) const

c } c } operator !=(const SoSFEnum &f) const Methods from class SoField: c } c } setIgnored(SbBool ignore)

c } c } isIgnored() const

c } c } isDefault() const

c } c } isOfType(SoType type) const

c } c } set(const char *valueString)

c } c } get(SbString &valueString)

c } c } touch()

c } c } connectFrom(SoField *fromField)

c } c } connectFrom(SoEngineOutput *fromEngine)

c } c } disconnect()

c } c } isConnected() const

c } c } isConnectedFromField() const

c } c } getConnectedField(SoField *&writingField) const

c } c } isConnectedFromEngine() const

c } c } getConnectedEngine(SoEngineOutput *&engineOutput) const

c } c } enableConnection(SbBool flag)

c } c } isConnectionEnabled() const

c } c } getForwardConnections(SoFieldList &list) const

c } c } getContainer() const

DESCRIPTION

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 man pages for specific nodes or engines for the names (e.g. SoDrawStyle).

METHODS

c } c } setValue(const SbName &name)

Sets this field to contain the given mnemonic name, passed in as a name or string. c } c } getClassTypeId()

c } c } getTypeId() const

Returns the type for this class or a particular object of this class. c } c } getValue() const

Returns this field's value. c } c } operator =(int newValue)

c } c } setValue(int newValue)

Sets this field to newValue. c } c } operator ==(const SoSFEnum &f) const

c } c } operator !=(const SoSFEnum &f) const

Returns TRUE if f is of the same type and has the same value as this field.

SEE ALSO

SoField, SoSField, SoMFEnum