GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOMFENUM (3)

NAME

SoMFEnum — multiple-value field containing any number of enumerated type values

CONTENTS

Inherits From
Synopsis
Description
Methods

INHERITS FROM

SoField > SoMField > SoMFEnum

SYNOPSIS

Methods from class SoMFEnum:

    void    
                    
void                 setValue(const SbName &name)    
void    
                    
void                 set1Value(int index, const SbName &name)    
static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const    
int    
                    
int                  operator [](int i) const    
const int *    
                    
const int *          getValues(int start) const    
int    
                    
int                  find(int targetValue, SbBool addIfNotFound = FALSE)    
void    
                    
void                 setValues(int start, int num, const int *newValues)    
void    
                    
void                 set1Value(int index, int newValue)    
int    
                    
int                  operator =(int newValue)    
void    
                    
void                 setValue(int newValue)    
int    
                    
int                  operator ==(const SoMFEnum &f) const    
int    
                    
int                  operator !=(const SoMFEnum &f) const    
int *    
                    
int *                startEditing()    
void    
                    
void                 finishEditing()

Methods from class SoMField:

    int    
                    
int                  getNum() const    
void    
                    
void                 setNum(int num)    
virtual void    
                    
virtual void         deleteValues(int start, int num = -1)    
virtual void    
                    
virtual void         insertSpace(int start, int num)    
SbBool    
                    
SbBool               set1(int index, const char *valueString)    
void    
                    
void                 get1(int index, SbString &valueString)

Methods from class SoField:

    void    
                    
void                 setIgnored(SbBool ignore)    
SbBool    
                    
SbBool               isIgnored() const    
SbBool    
                    
SbBool               isDefault() const    
virtual SbBool    
                    
virtual SbBool       isOfType(SoType type) const    
SbBool    
                    
SbBool               set(const char *valueString)    
void    
                    
void                 get(SbString &valueString)    
void    
                    
void                 touch()    
SbBool    
                    
SbBool               connectFrom(SoField *fromField)    
SbBool    
                    
SbBool               connectFrom(SoEngineOutput *fromEngine)    
void    
                    
void                 disconnect()    
SbBool    
                    
SbBool               isConnected() const    
SbBool    
                    
SbBool               isConnectedFromField() const    
SbBool    
                    
SbBool               getConnectedField(SoField *&writingField) const    
SbBool    
                    
SbBool               isConnectedFromEngine() const    
SbBool    
                    
SbBool               getConnectedEngine(SoEngineOutput *&engineOutput) const    
void    
                    
void                 enableConnection(SbBool flag)    
SbBool    
                    
SbBool               isConnectionEnabled() const    
int    
                    
int                  getForwardConnections(SoFieldList &list) const    
SoFieldContainer *    
                    
SoFieldContainer *   getContainer() const

DESCRIPTION

A multiple-value field that contains any number of enumerated type values, stored as ints. Nodes that use this field class define mnemonic names for 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.

SoMFEnums are written to file as a set of mnemonic enumerated type names. These names differ among uses of this field in various node classes. See the reference pages for specific nodes for the names.

When more than one value is present, all of the values are enclosed in square brackets and separated by commas.

METHODS

    void    
                    
void                 setValue(const SbName &name)
Sets this field to contain one and only one value, which is the mnemonic name as a string.

    void    
                    
void                 set1Value(int index, const SbName &name)
Sets the index’th value to be the integer corresponding to the mnemonic name in the given string.

    static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const
Returns the type for this class or a particular object of this class.

    int    
                    
int                  operator [](int i) const
Returns the i’th value of the field. Indexing past the end of the field (passing in i greater than getNum()) will return garbage.

    const int *    
                    
const int *          getValues(int start) const
Returns a pointer into the array of values in the field, starting at index start. The values are read-only; see the startEditing()/finishEditing() methods for a way of modifying values in place.

    int    
                    
int                  find(int targetValue, SbBool addIfNotFound = FALSE)
Finds the given value in the array and returns the index of that value in the array. If the value is not found, -1 is returned. If addIfNotFound is set, then targetValue is added to the end of the array (but -1 is still returned).

    void    
                    
void                 setValues(int start, int num, const int *newValues)
Sets num values starting at index start to the values in newValues. The array will be automatically be made larger to accomodate the new values, if necessary.

    void    
                    
void                 set1Value(int index, int newValue)
Sets the index’th value in the array to newValue. The array will be automatically expanded, if necessary.

    int    
                    
int                  operator =(int newValue)    
void    
                    
void                 setValue(int newValue)
Sets the first value in the array to newValue, and deletes the second and subsequent values.

    int    
                    
int                  operator ==(const SoMFEnum &f) const    
int    
                    
int                  operator !=(const SoMFEnum &f) const
Returns TRUE if all of the values of this field equal (do not equal) those of the given field. If the fields are different types FALSE will always be returned (even if one field is an SoMFFloat with one value of 1.0 and the other is an SoMFInt with a value of 1, for example).

    int *    
                    
int *                startEditing()    
void    
                    
void                 finishEditing()
startEditing() returns a pointer to the internally-maintained array that can be modified. The values in the array may be changed, but values cannot be added or removed. It is illegal to call any other editing methods between startEditing() and finishEditing() (e.g. set1Value(), setValue(), etc).

Fields, engines or sensors connected to this field and sensors are not notified that this field has changed until finishEditing() is called. Calling finishEditing() always sets the isDefault() flag to FALSE and informs engines and sensors that the field changed, even if none of the values actually were changed.

Search for    or go to Top of page |  Section 3 |  Main Index


SOMFENUM(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.