Field containing an enumerated value. More...

#include <Inventor/fields/SoSFEnum.h>

Inheritance diagram for SoSFEnum:

Public Member Functions
void	setValue (const SbName &name)
	Sets this field to contain the given mnemonic name, passed in as a name or string.
void	setEnums (int num, int vals, SbName names)
	Sets up value/name correspondances.
Static Public Member Functions
static void	initClass ()
Protected Member Functions
virtual SbBool	findEnumValue (const SbName &name, int &val)
	Looks up enum name, returns value. Returns FALSE if not found.
virtual SbBool	findEnumName (int val, const SbName *&name) const
	Looks up enum value, returns ptr to name. Returns FALSE if not found.
Protected Attributes
SbBool	legalValuesSet
	TRUE if setEnums called.
int	numEnums
	Number of enumeration values.
int *	enumValues
	Enumeration values.
SbName *	enumNames
	Mnemonic names of values.

Detailed 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).