SoMFEnum - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 3.1.3
Note : Coin

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

SYNOPSIS
#include <Inventor/fields/SoMFEnum​.h> Inherits SoMField​. Inherited by SoMFBitMask​.

Public Member Functionsvirtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoMFEnum & operator= (const SoMFEnum &field)
virtual SbBool isSame (const SoField &field) const
int operator[] (const int idx) const
const int * getValues (const int start) const
int find (int value, SbBool addifnotfound=FALSE)
void setValues (const int start, const int num, const int *newvals)
void set1Value (const int idx, int value)
void setValue (int value)
int operator= (int val)
SbBool operator== (const SoMFEnum &field) const
SbBool operator!= (const SoMFEnum &field) const
int * startEditing (void)
void finishEditing (void)
void setValue (const SbName name)
void set1Value (const int idx, const SbName name)
void setEnums (const int num, const int *const values, const SbName *const names)
int getNumEnums (void) const
int getEnum (const int idx, SbName &name) const

Static Public Member Functionsstatic void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (void)

Protected Member Functionsvirtual void deleteAllValues (void)
virtual void copyValue (int to, int from)
virtual int fieldSizeof (void) const
virtual void * valuesPtr (void)
virtual void setValuesPtr (void *ptr)
virtual void allocValues (int num)
virtual SbBool findEnumValue (const SbName &name, int &value)
virtual SbBool findEnumName (int value, const SbName *&name) const

Protected Attributesint * values
SbBool legalValuesSet
int numEnums
int * enumValues
SbName * enumNames

Additional Inherited Members

Detailed DescriptionThe 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 (int to, int from) [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 int start) const [inline]Returns a pointer to the values array​.

void SoMFEnum::setValue (const SbName name)Set this field to contain a single value by specifying an enumeration string​.

void SoMFEnum::set1Value (const int idx, const SbName name)Set the value at idx to the enumeration value represented by name​.

void SoMFEnum::setEnums (const int numarg, const int *const vals, const SbName *const names)Makes a set of num enumeration names map to vals​.

int SoMFEnum::getNumEnums (void) constReturns 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 int idx, SbName & name) constReturns 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 (int value, 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​.

AuthorGenerated automatically by Doxygen for Coin from the source code​.
0
Johanes Gumabo
Data Size   :   33,711 byte
man-SoMFEnum.3coin3Build   :   2024-12-05, 20:55   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   2 / 199,280
Visitor ID   :     :  
Visitor IP   :   52.14.148.63   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36

Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.