table of contents
other versions
- jessie 3.1.4~abc9f50-7
SoMFEnum(3) | Coin | SoMFEnum(3) |
NAME¶
SoMFEnum - The SoMFEnum class is a container for a set of enumerated values. This field is used where nodes, engines or other field containers needs to store values constrained to be from an enumerated set.SYNOPSIS¶
#include <Inventor/fields/SoMFEnum.h> Inherits SoMField. Inherited by SoMFBitMask.Public Member Functions¶
virtual SoType getTypeId (void) const
Static Public Member Functions¶
static void * createInstance (void)
Protected Member Functions¶
virtual void deleteAllValues (void)
Protected Attributes¶
int * values
Additional Inherited Members¶
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 needs 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¶
SoType SoMFEnum::getTypeId (void) const [virtual]¶
Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. See also:getClassTypeId(), SoType
Implements SoField.
Reimplemented in SoMFBitMask.
void SoMFEnum::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 SoMFBitMask.SbBool SoMFEnum::isSame (const SoField &f) const [virtual]¶
Check for equal type and value(s). Implements SoField. Reimplemented in SoMFBitMask.void SoMFEnum::deleteAllValues (void) [protected], [virtual]¶
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. Implements SoMField.void SoMFEnum::copyValue (intto, intfrom) [protected], [virtual]¶
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 contructors where necessary. Implements SoMField.const int* SoMFEnum::getValues (const intstart) const [inline]¶
\ Returns a pointer to the values array. \void SoMFEnum::setValue (const SbNamename)¶
Set this field to contain a single value by specifying an enumeration string.void SoMFEnum::set1Value (const intidx, const SbNamename)¶
Set the value at idx to the enumeration value represented by name.void SoMFEnum::setEnums (const intnumarg, const int *constvals, const SbName *constnames)¶
Makes a set of num enumeration names map to vals.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
int SoMFEnum::getEnum (const intidx, 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
SbBool SoMFEnum::findEnumValue (const SbName &name, int &val) [protected], [virtual]¶
Return in val the enumeration value which matches the given enumeration name. Returns TRUE if name is a valid enumeration string, otherwise FALSE.SbBool SoMFEnum::findEnumName (intvalue, const SbName *&name) const [protected], [virtual]¶
Set the enumeration name which matches the given enumeration value. Returns TRUE if value is a valid enumeration value, otherwise FALSE.Member Data Documentation¶
SbBool SoMFEnum::legalValuesSet [protected]¶
Is TRUE if a set of enum name-to-value mappings has been set.int SoMFEnum::numEnums [protected]¶
Number of enumeration mappings.int * SoMFEnum::enumValues [protected]¶
Array of enumeration values. Maps 1-to-1 with the enumNames.SbName * SoMFEnum::enumNames [protected]¶
Array of enumeration names. Maps 1-to-1 with the enumValues.Author¶
Generated automatically by Doxygen for Coin from the source code.Thu May 29 2014 | Version 4.0.0a |