Open Inventor Release 2024.2.0
 
Loading...
Searching...
No Matches
SoMFBitMask Class Reference

Multiple-value field containing any number of masks of bit flags. More...

#include <Inventor/fields/SoMFBitMask.h>

+ Inheritance diagram for SoMFBitMask:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
const SoMFBitMaskoperator= (const SoMFBitMask &f)
 Copy from another field of same type.
 
 SoMFBitMask ()
 Default constructor.
 
virtual ~SoMFBitMask ()
 Destructor.
 
int operator= (int newValue)
 Sets this field to newValue.
 
void setValuesPointer (int num, const int *userData)
 Sets the field to contain the num values stored in userData array.
 
void setValuesPointer (int num, int *userData)
 See setValuesPointer(int, const int *)
 
- Public Member Functions inherited from SoMFEnum
const SoMFEnumoperator= (const SoMFEnum &f)
 Copy from another field of same type.
 
 SoMFEnum ()
 Default constructor.
 
virtual ~SoMFEnum ()
 Destructor.
 
int * startEditing ()
 Returns a pointer to the internally maintained array that can be modified.
 
void finishEditing ()
 Indicates that batch edits have finished.
 
int operator[] (int i) const
 Returns the i'th value of the field.
 
const int * getValues (int start) const
 Returns a pointer into the array of values in the field, starting at index start.
 
int find (int targetValue, SbBool addIfNotFound=FALSE)
 Finds the given targetValue in the array and returns the index of that value.
 
void setValues (int start, int num, const int *newValues)
 Sets num values starting at index start to the values.
 
void set1Value (int index, int newValue)
 Sets the index'th value in the array to newValue.
 
void setValue (int newValue)
 Sets the first value in the array to newValue, and deletes.
 
int operator= (int newValue)
 Sets the first value in the array to newValue, and deletes.
 
int operator== (const SoMFEnum &f) const
 Returns TRUE if all of the values of this field equal those of.
 
int operator!= (const SoMFEnum &f) const
 Returns TRUE if all of the values of this field do not equal.
 
virtual void enableDeleteValues ()
 Sets the enableDeleteValues flag.
 
virtual void disableDeleteValues ()
 Temporary disable value deleting.
 
virtual SbBool isDeleteValuesEnabled ()
 Returns FALSE if user data array has been given to

 
virtual size_t getValueSize () const
 Get size of the value.
 
void setValuesPointer (int num, const int *userData)
 Sets the field to contain the num values stored in userData array.
 
void setValuesPointer (int num, int *userData)
 See setValuesPointer(int, const int *)
 
void setValue (const SbName &name)
 Sets this field to contain one and only one value, which is the mnemonic name as a string.
 
void getEnums (int &num, int *&vals, SbName *&names)
 Gets value/name correspondances.
 
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.
 
- Public Member Functions inherited from SoMField
int getNum () const
 Returns the number of values currently in the field.
 
void setNum (int num)
 Forces this field to have exactly num values, inserting or deleting values as necessary.
 
virtual void deleteValues (int start, int num=-1)
 Deletes num values beginning at index start (index start through start + num -1 will be deleted, and any leftover values will be moved down to fill in the gap created).
 
virtual void insertSpace (int start, int num)
 Inserts space for num values at index start .
 
SoNONUNICODE SbBool set1 (int index, const char *valueString)
 This is equivalent to the set() method of SoField, but operates on only one value.
 
SbBool set1 (int index, const SbString &valueString)
 This is equivalent to the set() method of SoField, but operates on only one value.
 
void get1 (int index, SbString &valueString)
 This is equivalent to the get() method of SoField, but operates on only one value.
 
- Public Member Functions inherited from SoField
void setIgnored (SbBool ig)
 Sets the ignore flag for this field.
 
SbBool isIgnored () const
 Gets the ignore flag for this field.
 
SbBool isDefault () const
 Gets the state of default flag of the field.
 
void enableConnection (SbBool flag)
 Field connections may be enabled and disabled.
 
SbBool isConnectionEnabled () const
 Returns FALSE if connections to this field are disabled.
 
SbBool connectFrom (SoEngineOutput *engineOutput)
 Connects this field from an engine output.
 
SbBool connectFrom (SoField *field)
 Connects this field to another field.
 
SbBool connectFrom (SoVRMLInterpOutput *interpOutput)
 Connects this field from an interpOutput.
 
SbBool appendConnection (SoEngineOutput *engineOutput)
 Appends this field to the list of connections from another engineOutput.
 
SbBool appendConnection (SoField *field)
 Appends this field to the list of connections from another field.
 
SbBool appendConnection (SoVRMLInterpOutput *interpOutput)
 Appends this field to the list of connections from another interpOutput.
 
void disconnect (SoEngineOutput *engineOutput)
 Disconnect the field from the requested engineOutput.
 
void disconnect (SoField *field)
 Disconnect the field from the requested field.
 
void disconnect (SoVRMLInterpOutput *interpOutput)
 Disconnect the field from the requested interpOutput.
 
int getNumConnections () const
 Returns the number of connections to this field.
 
int getConnections (SoFieldList &list)
 Returns a list of the connections to this field.
 
void disconnect ()
 Disconnect the field from whatever it was connected to.
 
SbBool isConnected () const
 Returns TRUE if the field is connected to anything.
 
SbBool isConnectedFromVRMLInterp () const
 Returns TRUE if the field is connected to a VRML interpOutput.
 
SbBool isConnectedFromEngine () const
 Returns TRUE if the field is connected to an engine's output.
 
SbBool isConnectedFromField () const
 Returns TRUE if the field is connected to another field.
 
SbBool getConnectedEngine (SoEngineOutput *&engineOutput) const
 Returns TRUE if this field is being written into by an engine, and returns the engine output it is connected to in engineOutput.
 
SbBool getConnectedField (SoField *&writingField) const
 Returns TRUE if this field is being written into by another field, and returns the field it is connected to in writingField.
 
SbBool getConnectedVRMLInterp (SoVRMLInterpOutput *&interpOutput) const
 Returns the VRMLInterpolator output field is connected to.
 
int getForwardConnections (SoFieldList &list) const
 Adds references to all of the fields that this field is writing into (either fields in nodes, global fields or engine inputs) to the given field list, and returns the number of forward connections.
 
SoFieldContainergetContainer () const
 Returns the object that contains this field.
 
SoNONUNICODE SbBool set (const char *valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
SbBool set (const SbString &valueString)
 Sets the field to the given value, which is an ASCII string in the Open Inventor file format.
 
void get (SbString &valueString)
 Returns the value of the field in the Open Inventor file format, even if the field has its default value.
 
virtual void touch ()
 Simulates a change to the field, causing attached sensors to fire, connected fields and engines to be marked as needing evaluation, and so forth.
 
int operator== (const SoField &f) const
 Return TRUE if this field is of the same type and has the same value as f.
 
int operator!= (const SoField &f) const
 Return FALSE if this field is of the same type and has the same value as f.
 
- Public Member Functions inherited from SoTypedObject
SbBool isOfType (const SoType &type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
template<typename TypedObjectClass >
SbBool isOfType () const
 Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.
 

Static Public Member Functions

static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoMFEnum
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 
- Static Public Member Functions inherited from SoMField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoField
static SoType getClassTypeId ()
 Return the type identifier for this field class.
 
- Static Public Member Functions inherited from SoTypedObject
static SoType getClassTypeId ()
 Returns the type identifier for this class.
 

Detailed Description

Multiple-value field containing any number of masks of bit flags.

A multiple-value field that contains any number of masks of bit flags, stored as ints. Nodes or engines that use this field class define mnemonic names for the bit flags. 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.

The bit-wise "&" and "|" operators should be used when testing and setting flags in a mask.

SoMFBitMasks are written to file as one or more mnemonic enumerated type names, in this format:

   ( flag1 | flag2 | ... )

If only one flag is used in a mask, the parentheses are optional. These names differ among uses of this field in various node or engine classes. See the reference pages for specific nodes or engines for the names.

The field values may also be represented as integers, but this is not guaranteed to be portable.

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

Data copying:

SoMF fields are a kind of "smart container", automatically expanding as necessary to hold the data provided by the application. This is very convenient, but for large blocks of data it may be desireable to avoid making a copy of the application data. The setValuesPointer() methods allow Open Inventor to directly use an array of values supplied by the application. The application data is not copied. Please see SoMFVec3f for more information and example code.

Definition at line 102 of file SoMFBitMask.h.

Constructor & Destructor Documentation

◆ SoMFBitMask()

SoMFBitMask::SoMFBitMask ( )

Default constructor.

◆ ~SoMFBitMask()

virtual SoMFBitMask::~SoMFBitMask ( )
virtual

Destructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoMFBitMask::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoMFBitMask::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoMFEnum.

◆ operator=() [1/2]

const SoMFBitMask & SoMFBitMask::operator= ( const SoMFBitMask f)

Copy from another field of same type.

◆ operator=() [2/2]

int SoMFBitMask::operator= ( int  newValue)
inline

Sets this field to newValue.

Definition at line 105 of file SoMFBitMask.h.

◆ setValuesPointer() [1/2]

void SoMFBitMask::setValuesPointer ( int  num,
const int *  userData 
)

Sets the field to contain the num values stored in userData array.

This array will not be copied into the field: it will be directly used by the field. If num and userData are not correctly specified, the results are undefined (and probably undesirable). param num is the number of values that userData contains and must be a positive integer. param userData is an array allocated by malloc or realloc and can be deallocated by free (no constructor or destructor is called). userData must not be NULL. Its size must be at least num*sizeof(valueType).

◆ setValuesPointer() [2/2]

void SoMFBitMask::setValuesPointer ( int  num,
int *  userData 
)

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