SoMFUniformShaderParameter Class Reference
[Fields]

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

#include <Inventor/fields/SoMFUniformShaderParameter.h>

Inheritance diagram for SoMFUniformShaderParameter:
SoMField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoMFUniformShaderParameteroperator= (const SoMFUniformShaderParameter &f)
 SoMFUniformShaderParameter ()
virtual ~SoMFUniformShaderParameter ()
SoUniformShaderParameteroperator[] (int i) const
const SoUniformShaderParameter ** getValues (int start) const
int find (SoUniformShaderParameter *targetValue, SbBool addIfNotFound=FALSE)
void setValues (int start, int num, const SoUniformShaderParameter **newValues)
void set1Value (int index, SoUniformShaderParameter *newValue)
void setValue (SoUniformShaderParameter *newValue)
SoUniformShaderParameteroperator= (SoUniformShaderParameter *newValue)
int operator== (const SoMFUniformShaderParameter &f) const
int operator!= (const SoMFUniformShaderParameter &f) const
virtual void enableDeleteValues ()
virtual void disableDeleteValues ()
virtual SbBool isDeleteValuesEnabled ()
virtual size_t getValueSize () const
void setValuesPointer (int num, const SoUniformShaderParameter **userData)
void setValuesPointer (int num, SoUniformShaderParameter **userData)
void addShaderParameter (SoUniformShaderParameter *shaderParameter)
void insertShaderParameter (SoUniformShaderParameter *shaderParameter, int newUniformShaderParameterIndex)
SoUniformShaderParametergetShaderParameter (int index) const
int findShaderParameter (const SoUniformShaderParameter *shaderParameter) const
SoUniformShaderParameterfindUniformParameterByName (const SbString &name)
int getNumShaderParameters () const
void removeShaderParameter (int index)
void removeShaderParameter (SoUniformShaderParameter *shaderParameter)
void removeShaderParameter (const SbString &name)
void removeAllShaderParameters ()
void replaceShaderParameter (int index, SoUniformShaderParameter *newUniformShaderParameter)
void replaceShaderParameter (SoUniformShaderParameter *oldUniformShaderParameter, SoUniformShaderParameter *newUniformShaderParameter)
SoUniformShaderParameter ** startEditing ()
void finishEditing ()

Static Public Member Functions

static SoType getClassTypeId ()

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.

Constructor & Destructor Documentation

SoMFUniformShaderParameter::SoMFUniformShaderParameter (  ) 

Default constructor.

virtual SoMFUniformShaderParameter::~SoMFUniformShaderParameter (  )  [virtual]

Destructor.


Member Function Documentation

void SoMFUniformShaderParameter::addShaderParameter ( SoUniformShaderParameter shaderParameter  ) 

Adds a uniform shader parameter as last one in group.

virtual void SoMFUniformShaderParameter::disableDeleteValues (  )  [inline, virtual]

Temporary disable value deleting.

virtual void SoMFUniformShaderParameter::enableDeleteValues (  )  [inline, virtual]

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.

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).

int SoMFUniformShaderParameter::findShaderParameter ( const SoUniformShaderParameter shaderParameter  )  const

Finds index of given uniform shader parameter within group.

SoUniformShaderParameter* SoMFUniformShaderParameter::findUniformParameterByName ( const SbString name  ) 

Find the first parameter with the given name.

Return NULL if not found.

void SoMFUniformShaderParameter::finishEditing (  ) 

Indicates that batch edits have finished.

See also:
startEditing().
static SoType SoMFUniformShaderParameter::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoMField.

int SoMFUniformShaderParameter::getNumShaderParameters (  )  const

Returns number of uniform shader parameters.

SoUniformShaderParameter* SoMFUniformShaderParameter::getShaderParameter ( int  index  )  const

Returns the n'th uniform shader parameter node.

virtual SoType SoMFUniformShaderParameter::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

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.

virtual size_t SoMFUniformShaderParameter::getValueSize (  )  const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

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

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

virtual SbBool SoMFUniformShaderParameter::isDeleteValuesEnabled (  )  [inline, virtual]

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.

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.

Reimplemented from SoField.

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

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

the second and subsequent values.

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

Copy from another field of same type.

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.

Reimplemented from SoField.

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.

void SoMFUniformShaderParameter::removeAllShaderParameters (  ) 

Removes all uniform shader parameters from group.

void SoMFUniformShaderParameter::removeShaderParameter ( const SbString name  ) 

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

void SoMFUniformShaderParameter::removeShaderParameter ( SoUniformShaderParameter shaderParameter  )  [inline]

Removes first instance of given uniform shader parameter from group.

void SoMFUniformShaderParameter::removeShaderParameter ( int  index  ) 

Removes uniform shader parameter with given index from group.

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

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

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

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

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.

void SoMFUniformShaderParameter::setValue ( SoUniformShaderParameter newValue  ) 

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

the second and subsequent values.

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.

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

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:

Open Inventor Toolkit reference manual, generated on 1 Nov 2022
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/