com.openinventor.inventor.fields

Class SoMFUniformShaderParameter

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.fields.SoField

com.openinventor.inventor.fields.SoMField

com.openinventor.inventor.fields.SoMFUniformShaderParameter

public class SoMFUniformShaderParameter
extends SoMField

Multiple-value field containing any number of SoUniformShaderParameter nodes. This field maintains a set of SoUniformShaderParameter instances.

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

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.fields.SoField

SoField.FieldTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoMFUniformShaderParameter() Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.
SoMFUniformShaderParameter(SoFieldContainer fieldContainer, java.lang.String fieldName, SoField.FieldTypes fieldType) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addShaderParameter(SoUniformShaderParameter shaderParameter) Adds a uniform shader parameter as last one in group.
void	disableDeleteValues() Temporary disable value deleting.
boolean	equals(java.lang.Object obj)
int	find(SoUniformShaderParameter targetValue) Calls find(targetValue, false).
int	find(SoUniformShaderParameter targetValue, boolean addIfNotFound) Finds the given targetValue in the array and returns the index of that value.
int	findShaderParameter(SoUniformShaderParameter shaderParameter) Finds index of given uniform shader parameter within group.
SoUniformShaderParameter	findUniformParameterByName(java.lang.String name) Find the first parameter with the given name.
SoUniformShaderParameter	get1Value(int i) Deprecated.
int	getNumShaderParameters() Returns number of uniform shader parameters.
SoUniformShaderParameter	getShaderParameter(int index) Returns the n'th uniform shader parameter node.
SoUniformShaderParameter	getValueAt(int i)
long	getValueSize() Get size of the value.
void	insertShaderParameter(SoUniformShaderParameter shaderParameter, int newUniformShaderParameterIndex) Adds a uniform shader parameter so that it becomes the one with the given index.
void	removeAllShaderParameters() Removes all uniform shader parameters from group.
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(java.lang.String name) Removes first instance of given uniform shader parameter with given name 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.
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.
void	setValues(int start, SoUniformShaderParameter[] newValues) Sets num values starting at index start to the values.

Methods inherited from class com.openinventor.inventor.fields.SoMField

deleteValues, deleteValues, get1, getNum, insertSpace, set1, setNum

Methods inherited from class com.openinventor.inventor.fields.SoField

appendConnection, appendConnection, appendConnection, connectFrom, connectFrom, connectFrom, disconnect, disconnect, disconnect, disconnect, enableConnection, get, getConnectedEngine, getConnectedField, getConnectedVRMLInterp, getContainer, getNumConnections, isConnected, isConnectedFromEngine, isConnectedFromField, isConnectedFromVRMLInterp, isConnectionEnabled, isDefault, isIgnored, set, setIgnored, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoMFUniformShaderParameter

@Deprecated
public SoMFUniformShaderParameter()

Deprecated. As of Open Inventor 9.3 Use constructor with SoFieldContainer instead.

SoMFUniformShaderParameter

public SoMFUniformShaderParameter(SoFieldContainer fieldContainer,
                                  java.lang.String fieldName,
                                  SoField.FieldTypes fieldType)

Default constructor.

Method Detail

find

public int find(SoUniformShaderParameter targetValue)

Calls find(targetValue, false).

get1Value

@Deprecated
public SoUniformShaderParameter get1Value(int i)

Deprecated.

getValueAt

public SoUniformShaderParameter getValueAt(int i)

getNumShaderParameters

public int getNumShaderParameters()

Returns number of uniform shader parameters.

setValues

public void setValues(int start,
                      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. In that case, if field's values are stored in an user data array, this array is no more used.

find

public int find(SoUniformShaderParameter targetValue,
                boolean addIfNotFound)

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

addShaderParameter

public void addShaderParameter(SoUniformShaderParameter shaderParameter)

Adds a uniform shader parameter as last one in group.

findShaderParameter

public int findShaderParameter(SoUniformShaderParameter shaderParameter)

Finds index of given uniform shader parameter within group.

getShaderParameter

public SoUniformShaderParameter getShaderParameter(int index)

Returns the n'th uniform shader parameter node.

insertShaderParameter

public void insertShaderParameter(SoUniformShaderParameter shaderParameter,
                                  int newUniformShaderParameterIndex)

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

findUniformParameterByName

public SoUniformShaderParameter findUniformParameterByName(java.lang.String name)

Find the first parameter with the given name. Return NULL if not found.

set1Value

public void set1Value(int index,
                      SoUniformShaderParameter newValue)

Sets the index'th value in the array to newValue. The array will be automatically expanded, if necessary. In that case, if field's values are stored in an user data array, this array is no more used.

disableDeleteValues

public void disableDeleteValues()

Temporary disable value deleting.

removeAllShaderParameters

public void removeAllShaderParameters()

Removes all uniform shader parameters from group.

removeShaderParameter

public void removeShaderParameter(java.lang.String name)

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SoField

replaceShaderParameter

public void replaceShaderParameter(int index,
                                   SoUniformShaderParameter newUniformShaderParameter)

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

removeShaderParameter

public void removeShaderParameter(int index)

Removes uniform shader parameter with given index from group.

replaceShaderParameter

public void replaceShaderParameter(SoUniformShaderParameter oldUniformShaderParameter,
                                   SoUniformShaderParameter newUniformShaderParameter)

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

setValue

public void setValue(SoUniformShaderParameter newValue)

Sets the first value in the array to newValue, and deletes. the second and subsequent values. If field's values are stored in an user data array, this array is no more used.

getValueSize

public long getValueSize()

Get size of the value.

Specified by:

getValueSize in class SoMField

removeShaderParameter

public void removeShaderParameter(SoUniformShaderParameter shaderParameter)

Removes first instance of given uniform shader parameter from group.