The SoMFEnum class is a container for a set of enumerated values. More...

#include <Inventor/fields/SoMFEnum.h>

Inheritance diagram for SoMFEnum:

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

int	find (int value, SbBool addifnotfound=FALSE)

void	finishEditing (void)

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

int	getNumEnums (void) const

SoType	getTypeId (void) const override

const int *	getValues (const int start) const

SbBool	isSame (const SoField &field) const override

SbBool	operator!= (const SoMFEnum &field) const

const SoMFEnum &	operator= (const SoMFEnum &field)

int	operator= (int val)

SbBool	operator== (const SoMFEnum &field) const

int	operator[] (const int idx) const

void	set1Value (const int idx, const SbName name)

void	set1Value (const int idx, int value)

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

void	setValue (const SbName name)

void	setValue (int value)

void	setValues (const int start, const int num, const int *newvals)

int *	startEditing (void)

Public Member Functions inherited from SoMField
virtual	~SoMField ()

virtual void	deleteValues (int start, int num=-1)

virtual void	enableDeleteValues (void)

void	get1 (const int index, SbString &valuestring)

int	getNum (void) const

virtual void	insertSpace (int start, int num)

virtual SbBool	isDeleteValuesEnabled (void) const

SbBool	set1 (const int index, const char *const valuestring)

void	setNum (const int num)

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 SoMField
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
void	allocValues (int num) override

void	copyValue (int to, int from) override

void	deleteAllValues (void) override

int	fieldSizeof (void) const override

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

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

void	setValuesPtr (void *ptr) override

void *	valuesPtr (void) override

Protected Member Functions inherited from SoMField
	SoMField (void)

SoNotRec	createNotRec (SoBase *container) override

virtual void	makeRoom (int newnum)

void	setChangedIndex (const int chgidx)

void	setChangedIndices (const int chgidx=-1, const int numchgind=0)

Protected Member Functions inherited from SoField
	SoField (void)

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 *	values

Protected Attributes inherited from SoMField
int	maxNum

int	num

SbBool	userDataIsUsed

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

Detailed Description

The SoMFEnum class is a container for a set of enumerated values.

This field is used where nodes, engines or other field containers need to store values constrained to be from an enumerated set.

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

See also: SoSFEnum, SoMFBitMask

Member Function Documentation

◆ copyFrom()

void SoMFEnum::copyFrom ( const SoField & f )

overridevirtual

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

Implements SoField.

◆ copyValue()

void SoMFEnum::copyValue	(	int	to,
		int	from )

overrideprotectedvirtual

This method is used for moving values around internally within a multivalue field. It needs to be overridden in each field so it automatically takes care of running copy constructors where necessary.

Implements SoMField.

◆ createInstance()

void * SoMFEnum::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.

◆ deleteAllValues()

void SoMFEnum::deleteAllValues ( void )

overrideprotectedvirtual

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

Implements SoMField.

◆ findEnumName()

SbBool SoMFEnum::findEnumName	(	int	value,
		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 SoMFEnum::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 SoMFEnum::getClassTypeId ( void )

static

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

◆ getEnum()

int SoMFEnum::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.

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 SoMFEnum::getNumEnums ( void ) const

Returns the number of enum names the SoSFEnum object understands.

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 SoMFEnum::getTypeId ( void ) const

overridevirtual

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.

◆ getValues()

const int * SoMFEnum::getValues ( const int start ) const

inline

Returns a pointer to the values array.

◆ initClass()

void SoMFEnum::initClass ( void )

static

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

◆ isSame()

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

overridevirtual

Check for equal type and value(s).

Implements SoField.

◆ set1Value()

void SoMFEnum::set1Value	(	const int	idx,
		const SbName	name )

Set the value at idx to the enumeration value represented by name.

◆ setEnums()

void SoMFEnum::setEnums	(	const int	numarg,
		const int *const	vals,
		const SbName *const	names )

Makes a set of num enumeration names map to vals.

◆ setValue()

void SoMFEnum::setValue ( const SbName name )

Set this field to contain a single value by specifying an enumeration string.

Member Data Documentation

◆ enumNames

SbName * SoMFEnum::enumNames

protected

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

◆ enumValues

int * SoMFEnum::enumValues

protected

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

◆ legalValuesSet

SbBool SoMFEnum::legalValuesSet

protected

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

◆ numEnums

int SoMFEnum::numEnums

protected

Number of enumeration mappings.

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

SoMFEnum.h
SoMFEnum.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ copyFrom()

◆ copyValue()

◆ createInstance()

◆ deleteAllValues()

◆ findEnumName()

◆ findEnumValue()

◆ getClassTypeId()

◆ getEnum()

◆ getNumEnums()

◆ getTypeId()

◆ getValues()

◆ initClass()

◆ isSame()

◆ set1Value()

◆ setEnums()

◆ setValue()

Member Data Documentation

◆ enumNames

◆ enumValues

◆ legalValuesSet

◆ numEnums