Package com.openinventor.inventor.fields

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

    • Constructor Detail

      • SoMFUniformShaderParameter

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

    • Method Detail

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

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

      • getNumShaderParameters

        public int getNumShaderParameters()
        Returns number of uniform shader parameters.

      • removeShaderParameter

        public void removeShaderParameter​(SoUniformShaderParameter shaderParameter)
        Removes first instance of given uniform shader parameter from group.

      • removeShaderParameter

        public void removeShaderParameter​(int index)
        Removes uniform shader parameter with given index from group.

      • insertShaderParameter

        public void insertShaderParameter​(SoUniformShaderParameter shaderParameter,
                                  int newUniformShaderParameterIndex)
        Adds a uniform shader parameter so that it becomes the one with the given index.

      • getShaderParameter

        public SoUniformShaderParameter getShaderParameter​(int index)
        Returns the n'th uniform shader parameter node.

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

      • replaceShaderParameter

        public void replaceShaderParameter​(SoUniformShaderParameter oldUniformShaderParameter,
                                   SoUniformShaderParameter newUniformShaderParameter)
        Replaces first instance of given uniform shader parameter with new uniform shader parameter.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class SoField

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

      • removeShaderParameter

        public void removeShaderParameter​(java.lang.String name)
        Removes first instance of given uniform shader parameter with given name from group.

      • disableDeleteValues

        public void disableDeleteValues()
        Temporary disable value deleting.

      • replaceShaderParameter

        public void replaceShaderParameter​(int index,
                                   SoUniformShaderParameter newUniformShaderParameter)
        Replaces uniform shader parameter with given index with new uniform shader parameter.

      • removeAllShaderParameters

        public void removeAllShaderParameters()
        Removes all uniform shader parameters from group.