Open Inventor Release 2024.1.2
 
Loading...
Searching...
No Matches
SoMFUniformShaderParameter Class Reference

VSG extension Multiple-value field containing any number of SoUniformShaderParameter nodes. More...

#include <Inventor/fields/SoMFUniformShaderParameter.h>

+ Inheritance diagram for SoMFUniformShaderParameter:

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
const SoMFUniformShaderParameteroperator= (const SoMFUniformShaderParameter &f)
 Copy from another field of same type.
 
 SoMFUniformShaderParameter ()
 Default constructor.
 
virtual ~SoMFUniformShaderParameter ()
 Destructor.
 
SoUniformShaderParameteroperator[] (int i) const
 Returns the i'th value of the field.
 
const SoUniformShaderParameter ** getValues (int start) const
 Returns a pointer into the array of values in the field, starting at index start.
 
int find (SoUniformShaderParameter *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 SoUniformShaderParameter **newValues)
 Sets num values starting at index start to the values.
 
void set1Value (int index, SoUniformShaderParameter *newValue)
 Sets the index'th value in the array to newValue.
 
void setValue (SoUniformShaderParameter *newValue)
 Sets the first value in the array to newValue, and deletes.
 
SoUniformShaderParameteroperator= (SoUniformShaderParameter *newValue)
 Sets the first value in the array to newValue, and deletes.
 
int operator== (const SoMFUniformShaderParameter &f) const
 Returns TRUE if all of the values of this field equal those of.
 
int operator!= (const SoMFUniformShaderParameter &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 SoUniformShaderParameter **userData)
 Sets the field to contain the num values stored in userData array.
 
void setValuesPointer (int num, SoUniformShaderParameter **userData)
 See setValuesPointer(int, const SoUniformShaderParameter * *)
 
void addShaderParameter (SoUniformShaderParameter *shaderParameter)
 Adds a uniform shader parameter as last one in group.
 
void insertShaderParameter (SoUniformShaderParameter *shaderParameter, int newUniformShaderParameterIndex)
 Adds a uniform shader parameter so that it becomes the one with the given index.
 
SoUniformShaderParametergetShaderParameter (int index) const
 Returns the n'th uniform shader parameter node.
 
int findShaderParameter (const SoUniformShaderParameter *shaderParameter) const
 Finds index of given uniform shader parameter within group.
 
SoUniformShaderParameterfindUniformParameterByName (const SbString &name)
 Find the first parameter with the given name.
 
int getNumShaderParameters () const
 Returns number of uniform shader parameters.
 
void removeShaderParameter (int index)
 Removes uniform shader parameter with given index from group.
 
void removeShaderParameter (SoUniformShaderParameter *shaderParameter)
 Removes first instance of given uniform shader parameter from group.
 
void removeShaderParameter (const SbString &name)
 Removes first instance of given uniform shader parameter with given name from group.
 
void removeAllShaderParameters ()
 Removes all uniform shader parameters from group.
 
void replaceShaderParameter (int index, SoUniformShaderParameter *newUniformShaderParameter)
 Replaces uniform shader parameter with given index with new uniform shader parameter.
 
void replaceShaderParameter (SoUniformShaderParameter *oldUniformShaderParameter, SoUniformShaderParameter *newUniformShaderParameter)
 Replaces first instance of given uniform shader parameter with new uniform shader parameter.
 
SoUniformShaderParameter ** startEditing ()
 Returns a pointer to the internally maintained array that can be modified.
 
void finishEditing ()
 Indicates that batch edits have finished.
 
- 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 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

VSG extension Multiple-value field containing any number of SoUniformShaderParameter nodes.

This field maintains a set of SoUniformShaderParameter instances , correctly maintaining their reference counts .

An SoMFUniformShaderParameter is written to file as one or more SoUniformShaderParameters. When more than one value is present, all of the values are enclosed in square brackets and separated by commas. For example:

   [ ShaderParameter1f {
       name "shininess"
       value 20
     },

     ShaderParameter3f {
       name "eyePosition"
       value 0 0 0
     }
   ]

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 71 of file SoMFUniformShaderParameter.h.

Constructor & Destructor Documentation

◆ SoMFUniformShaderParameter()

SoMFUniformShaderParameter::SoMFUniformShaderParameter ( )

Default constructor.

◆ ~SoMFUniformShaderParameter()

virtual SoMFUniformShaderParameter::~SoMFUniformShaderParameter ( )
virtual

Destructor.

Member Function Documentation

◆ addShaderParameter()

void SoMFUniformShaderParameter::addShaderParameter ( SoUniformShaderParameter shaderParameter)

Adds a uniform shader parameter as last one in group.

◆ disableDeleteValues()

virtual void SoMFUniformShaderParameter::disableDeleteValues ( )
inlinevirtual

Temporary disable value deleting.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ enableDeleteValues()

virtual void SoMFUniformShaderParameter::enableDeleteValues ( )
inlinevirtual

Sets the enableDeleteValues flag.

This flag (if TRUE) allows Open Inventor to destroy the user data array given to setValuesPointer(). This user data array will be managed exactly like internal field data values. Default is FALSE.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ find()

int SoMFUniformShaderParameter::find ( SoUniformShaderParameter targetValue,
SbBool  addIfNotFound = FALSE 
)

Finds the given targetValue 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).

◆ findShaderParameter()

int SoMFUniformShaderParameter::findShaderParameter ( const SoUniformShaderParameter shaderParameter) const

Finds index of given uniform shader parameter within group.

◆ findUniformParameterByName()

SoUniformShaderParameter * SoMFUniformShaderParameter::findUniformParameterByName ( const SbString name)

Find the first parameter with the given name.

Return NULL if not found.

◆ finishEditing()

void SoMFUniformShaderParameter::finishEditing ( )

Indicates that batch edits have finished.

See also
startEditing().

◆ getClassTypeId()

static SoType SoMFUniformShaderParameter::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getNumShaderParameters()

int SoMFUniformShaderParameter::getNumShaderParameters ( ) const

Returns number of uniform shader parameters.

◆ getShaderParameter()

SoUniformShaderParameter * SoMFUniformShaderParameter::getShaderParameter ( int  index) const

Returns the n'th uniform shader parameter node.

◆ getTypeId()

virtual SoType SoMFUniformShaderParameter::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ getValues()

const SoUniformShaderParameter ** SoMFUniformShaderParameter::getValues ( int  start) const
inline

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.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ getValueSize()

virtual size_t SoMFUniformShaderParameter::getValueSize ( ) const
inlinevirtual

Get size of the value.

Reimplemented from SoField.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ insertShaderParameter()

void SoMFUniformShaderParameter::insertShaderParameter ( SoUniformShaderParameter shaderParameter,
int  newUniformShaderParameterIndex 
)

Adds a uniform shader parameter so that it becomes the one with the given index.

◆ isDeleteValuesEnabled()

virtual SbBool SoMFUniformShaderParameter::isDeleteValuesEnabled ( )
inlinevirtual

Returns FALSE if user data array has been given to

setValuesPointer() and enableDeleteValues() has never been called, and memory for data has not been reallocated. Otherwise, returns TRUE.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ operator!=()

int SoMFUniformShaderParameter::operator!= ( const SoMFUniformShaderParameter f) const
inline

Returns TRUE if all of the values of this field do not equal.

those of the given f. If the fields are different types TRUE will always be returned.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ operator=() [1/2]

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

Copy from another field of same type.

◆ operator=() [2/2]

SoUniformShaderParameter * SoMFUniformShaderParameter::operator= ( SoUniformShaderParameter newValue)
inline

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ operator==()

int SoMFUniformShaderParameter::operator== ( const SoMFUniformShaderParameter f) const

Returns TRUE if all of the values of this field equal those of.

the given f. If the fields are different types FALSE will always be returned.

◆ operator[]()

SoUniformShaderParameter * SoMFUniformShaderParameter::operator[] ( int  i) const
inline

Returns the i'th value of the field.

Indexing past the end of the field (passing in i greater than getNum()) will return garbage.

Definition at line 75 of file SoMFUniformShaderParameter.h.

◆ removeAllShaderParameters()

void SoMFUniformShaderParameter::removeAllShaderParameters ( )

Removes all uniform shader parameters from group.

◆ removeShaderParameter() [1/3]

void SoMFUniformShaderParameter::removeShaderParameter ( const SbString name)

Removes first instance of given uniform shader parameter with given name from group.

◆ removeShaderParameter() [2/3]

void SoMFUniformShaderParameter::removeShaderParameter ( int  index)

Removes uniform shader parameter with given index from group.

◆ removeShaderParameter() [3/3]

void SoMFUniformShaderParameter::removeShaderParameter ( SoUniformShaderParameter shaderParameter)
inline

Removes first instance of given uniform shader parameter from group.

Definition at line 126 of file SoMFUniformShaderParameter.h.

◆ replaceShaderParameter() [1/2]

void SoMFUniformShaderParameter::replaceShaderParameter ( int  index,
SoUniformShaderParameter newUniformShaderParameter 
)

Replaces uniform shader parameter with given index with new uniform shader parameter.

◆ replaceShaderParameter() [2/2]

void SoMFUniformShaderParameter::replaceShaderParameter ( SoUniformShaderParameter oldUniformShaderParameter,
SoUniformShaderParameter newUniformShaderParameter 
)
inline

Replaces first instance of given uniform shader parameter with new uniform shader parameter.

Definition at line 152 of file SoMFUniformShaderParameter.h.

◆ set1Value()

void SoMFUniformShaderParameter::set1Value ( int  index,
SoUniformShaderParameter newValue 
)

Sets the index'th value in the array to newValue.

The array will be automatically expanded, if necessary.

◆ setValue()

void SoMFUniformShaderParameter::setValue ( SoUniformShaderParameter newValue)

Sets the first value in the array to newValue, and deletes.

the second and subsequent values.

◆ setValues()

void SoMFUniformShaderParameter::setValues ( int  start,
int  num,
const SoUniformShaderParameter **  newValues 
)

Sets num values starting at index start to the values.

in newValues. The array will automatically be made larger to accommodate the new values, if necessary.

◆ setValuesPointer() [1/2]

void SoMFUniformShaderParameter::setValuesPointer ( int  num,
const SoUniformShaderParameter **  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 SoMFUniformShaderParameter::setValuesPointer ( int  num,
SoUniformShaderParameter **  userData 
)

◆ startEditing()

SoUniformShaderParameter ** SoMFUniformShaderParameter::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.


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