The SoSFEnum class is a container for an enum value. More...

#include <Inventor/fields/SoSFEnum.h>

Inheritance diagram for SoSFEnum:

Public Member Functions
virtual void	copyFrom (const SoField &field)

int	getEnum (const int idx, SbName &name) const

int	getNumEnums (void) const

virtual SoType	getTypeId (void) const

int	getValue (void) const

virtual SbBool	isSame (const SoField &field) const

int	operator!= (const SoSFEnum &field) const

const SoSFEnum &	operator= (const SoSFEnum &field)

int	operator= (int newvalue)

int	operator== (const SoSFEnum &field) const

void	setEnums (const int num, const int vals, const SbName names)

void	setValue (const SbName name)

void	setValue (int newvalue)

Public Member Functions inherited from SoSField
virtual	~SoSField ()

Public Member Functions inherited from SoField
virtual	~SoField ()

void	addAuditor (void *f, SoNotRec::Type type)

SbBool	appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)

SbBool	appendConnection (SoField *master, SbBool notnotify=FALSE)

SbBool	connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)

SbBool	connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)

virtual void	connectionStatusChanged (int numconnections)

void	copyConnection (const SoField *fromfield)

virtual void	countWriteRefs (SoOutput *out) const

void	disconnect (SoEngineOutput *engineoutput)

void	disconnect (SoField *field)

void	disconnect (void)

void	enableConnection (SbBool flag)

SbBool	enableNotify (SbBool on)

void	evaluate (void) const

virtual void	fixCopy (SbBool copyconnections)

void	get (SbString &valuestring)

SbBool	getConnectedEngine (SoEngineOutput *&master) const

SbBool	getConnectedField (SoField *&master) const

int	getConnections (SoFieldList &masterlist) const

SoFieldContainer *	getContainer (void) const

SbBool	getDirty (void) const

int	getFieldType (void) const

int	getForwardConnections (SoFieldList &slavelist) const

int	getNumConnections (void) const

SbBool	isConnected (void) const

SbBool	isConnectedFromEngine (void) const

SbBool	isConnectedFromField (void) const

SbBool	isConnectionEnabled (void) const

SbBool	isDefault (void) const

SbBool	isIgnored (void) const

SbBool	isNotifyEnabled (void) const

SbBool	isOfType (const SoType type) const

SbBool	isReadOnly (void) const

virtual void	notify (SoNotList *nlist)

int	operator!= (const SoField &f) const

int	operator== (const SoField &f) const

virtual SbBool	read (SoInput *input, const SbName &name)

virtual SbBool	referencesCopy (void) const

void	removeAuditor (void *f, SoNotRec::Type type)

SbBool	set (const char *valuestring)

void	setContainer (SoFieldContainer *cont)

void	setDefault (SbBool defaultVal)

void	setDirty (SbBool dirty)

void	setFieldType (int type)

void	setIgnored (SbBool ignore)

SbBool	shouldWrite (void) const

virtual void	startNotify (void)

virtual void	touch (void)

virtual void	write (SoOutput *out, const SbName &name) const

Static Public Member Functions
static void *	createInstance (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoSField
static void	atexit_cleanup (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

Static Public Member Functions inherited from SoField
static void	cleanupClass (void)

static SoType	getClassTypeId (void)

static void	initClass (void)

static void	initClasses (void)

Protected Member Functions
virtual SbBool	findEnumName (int value, const SbName *&name) const

virtual SbBool	findEnumValue (const SbName &name, int &val)

Protected Member Functions inherited from SoSField
	SoSField (void)

Protected Member Functions inherited from SoField
	SoField (void)

virtual SoNotRec	createNotRec (SoBase *cont)

virtual void	evaluateConnection (void) const

SbBool	isDestructing (void) const

virtual SbBool	readConnection (SoInput *in)

void	valueChanged (SbBool resetdefault=TRUE)

virtual void	writeConnection (SoOutput *out) const

Protected Attributes
SbName *	enumNames

int *	enumValues

SbBool	legalValuesSet

int	numEnums

int	value

Additional Inherited Members
Public Types inherited from SoField
enum	FieldType { NORMAL_FIELD = 0 , EVENTIN_FIELD , EVENTOUT_FIELD , EXPOSED_FIELD }

Detailed Description

The SoSFEnum class is a container for an enum value.

This field is used where nodes, engines or other field containers needs to store one particular value out of an enumerated set.

A field of this type stores its value to file as the symbolic name, rather than the actual integer value.

SoSFEnum instances are initialized on an instance basis, usually in the constructor of the field container with the macros SO_NODE_DEFINE_ENUM_VALUE(enumtype, symbolvalue) and SO_NODE_SET_SF_ENUM_TYPE(enumfield, enumtype) for nodes, or for engines; SO_ENGINE_DEFINE_ENUM_VALUE() and SO_ENGINE_SET_SF_ENUM_TYPE().

Example initialization from the constructor of the SoCone class:

SO_NODE_DEFINE_ENUM_VALUE(Part, SIDES);
SO_NODE_DEFINE_ENUM_VALUE(Part, BOTTOM);
SO_NODE_DEFINE_ENUM_VALUE(Part, ALL);
SO_NODE_SET_SF_ENUM_TYPE(parts, Part); 

See also: SoMFEnum, SoSFBitMask

Member Function Documentation

◆ copyFrom()

void SoSFEnum::copyFrom ( const SoField & f )

virtual

Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

Reimplemented in SoSFBitMask.

◆ createInstance()

void * SoSFEnum::createInstance ( void )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

◆ findEnumName()

SbBool SoSFEnum::findEnumName	(	int	valuearg,
		const SbName *&	name ) const

protectedvirtual

Set the enumeration name which matches the given enumeration value.

Returns TRUE if value is a valid enumeration value, otherwise FALSE.

◆ findEnumValue()

SbBool SoSFEnum::findEnumValue	(	const SbName &	name,
		int &	val )

protectedvirtual

Return in val the enumeration value which matches the given enumeration name.

Returns TRUE if name is a valid enumeration string, otherwise FALSE.

◆ getClassTypeId()

SoType SoSFEnum::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

◆ getEnum()

int SoSFEnum::getEnum	(	const int	idx,
		SbName &	name ) const

Returns the value of the Nth enum this SoSFEnum object understands, and mutates name to contain the Nth enum's name.

Note that this API method is not part of the original SGI Inventor 2.1 API, and is an extension specific to Coin.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since: Coin 2.0

◆ getNumEnums()

int SoSFEnum::getNumEnums ( void ) const

Returns the number of enum names the SoSFEnum object understands.

Note that this API method is not part of the original SGI Inventor 2.1 API, and is an extension specific to Coin.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since: Coin 2.0

◆ getTypeId()

SoType SoSFEnum::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and "downward" casting.

Implements SoField.

Reimplemented in SoSFBitMask.

◆ initClass()

void SoSFEnum::initClass ( void )

static

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

◆ isSame()

SbBool SoSFEnum::isSame ( const SoField & f ) const

virtual

Check for equal type and value(s).

Implements SoField.

Reimplemented in SoSFBitMask.

◆ setEnums()

void SoSFEnum::setEnums	(	const int	num,
		const int *	vals,
		const SbName *	names )

Makes a set of num enumeration names map to integer values, given by vals.

◆ setValue()

void SoSFEnum::setValue ( const SbName name )

Set the value of this field by specifying an enumeration string value.

Member Data Documentation

◆ enumNames

SbName * SoSFEnum::enumNames

protected

Array of enumeration names. Maps 1-to-1 with the enumValues.

◆ enumValues

int * SoSFEnum::enumValues

protected

Array of enumeration values. Maps 1-to-1 with the enumNames.

◆ legalValuesSet

SbBool SoSFEnum::legalValuesSet

protected

Is TRUE if a set of enum name-to-value mappings has been set.

◆ numEnums

int SoSFEnum::numEnums

protected

Number of enumeration mappings.

The documentation for this class was generated from the following files:

SoSFEnum.h
SoSFEnum.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copyFrom()

◆ createInstance()

◆ findEnumName()

◆ findEnumValue()

◆ getClassTypeId()

◆ getEnum()

◆ getNumEnums()

◆ getTypeId()

◆ initClass()

◆ isSame()

◆ setEnums()

◆ setValue()

Member Data Documentation

◆ enumNames

◆ enumValues

◆ legalValuesSet

◆ numEnums