Click or drag to resize
SoUniformShaderParameter Class

Abstract base class for all uniform shader parameter nodes.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)
Syntax
public class SoUniformShaderParameter : SoShaderParameter

The SoUniformShaderParameter type exposes the following members.

Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoNode.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoNode.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Inherited from SoNode.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsEqual
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyidentifier

Specifies the parameter's integer name which is declared and used within low-level shading programs.

(Inherited from SoShaderParameter.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyname

Specifies the parameter's string name which is declared and used within high-level shading programs.

(Inherited from SoShaderParameter.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This is the abstract class from which all the uniform shader parameter nodes, e.g. OIV.Inventor.Nodes.SoShaderParameter1i, are derived.

These nodes allow users to provide uniform parameters to a given shader object, e.g. OIV.Inventor.Nodes.SoFragmentShader.

Uniform shader parameter nodes are usually added to the shader object's parameter field to affect only that specific shader program. They can also be inserted in the scene graph after an OIV.Inventor.Nodes.SoShaderProgram. In this case they affect whatever shader program is in effect when a shape is rendered.

Each parameter is defined by the following properties:

  • name and/or identifier,

  • value.

See the base class OIV.Inventor.Nodes.SoShaderParameter to get information about how to specify the name and/or identifier of a parameter.

The following examples show how to set a parameter named "scale" in two different ways.

EXAMPLE

In this case, a uniform parameter is added to a specific shader program:

SoShaderParameter3f parameterNode = new SoShaderParameter3f();
 parameterNode.name.Value = "scale";
 parameterNode.value.SetValue(2, 2, 2);

SoVertexShader vertexShader = new SoVertexShader();
 vertexShader.sourceProgram.Value = "filename.glsl";
 vertexShader.parameter[0] = parameterNode;  // Affects this shader

SoShaderProgram shaderProgram = new SoShaderProgram();
 shaderProgram.shaderObject[0] = vertexShader;
root.AddChild(shaderProgram);

EXAMPLE

This code sets a uniform parameter with an OIV.Inventor.Nodes.SoShaderParameter included in the scene graph:

SoShaderParameter3f parameterNode = new SoShaderParameter3f();
 parameterNode.name.Value = "scale";
 parameterNode.value.SetValue(2, 2, 2);
root.AddChild( parameterNode ); // Affects all subsequent shaders

SoVertexShader vertexShader = new SoVertexShader();
 vertexShader.sourceProgram.Value = "filename.glsl";

SoShaderProgram shaderProgram = new SoShaderProgram();
 shaderProgram.shaderObject[0] = vertexShader;
root.AddChild(shaderProgram);

FILE FORMAT/DEFAULT

This is an abstract class. See the reference page of a derived class for the format and default values.

See Also
Inheritance Hierarchy
SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoShaderParameter
              OIV.Inventor.NodesSoUniformShaderParameter
                OIV.Inventor.NodesSoShaderParameter1f
                OIV.Inventor.NodesSoShaderParameter1i
                OIV.Inventor.NodesSoShaderParameter2f
                OIV.Inventor.NodesSoShaderParameter2i
                OIV.Inventor.NodesSoShaderParameter3f
                OIV.Inventor.NodesSoShaderParameter3i
                OIV.Inventor.NodesSoShaderParameter4f
                OIV.Inventor.NodesSoShaderParameter4i
                OIV.Inventor.NodesSoShaderParameterArray1f
                OIV.Inventor.NodesSoShaderParameterArray1i
                OIV.Inventor.NodesSoShaderParameterArray2f
                OIV.Inventor.NodesSoShaderParameterArray2i
                OIV.Inventor.NodesSoShaderParameterArray3f
                OIV.Inventor.NodesSoShaderParameterArray3i
                OIV.Inventor.NodesSoShaderParameterArray4f
                OIV.Inventor.NodesSoShaderParameterArray4i
                OIV.Inventor.NodesSoShaderParameterMatrix
                OIV.Inventor.NodesSoShaderParameterMatrix3
                OIV.Inventor.NodesSoShaderParameterMatrixArray
                OIV.Inventor.NodesSoShaderStateMatrixParameter