SoUniformShaderParameter Class |
Abstract base class for all uniform shader parameter nodes.
Namespace: OIV.Inventor.Nodes
The SoUniformShaderParameter type exposes the following members.
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoNode.) | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoNode.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | (Inherited from SoNode.) | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetMatrix | (Inherited from SoNode.) | |
GetName | Returns the name of an instance. | |
GetPrimitiveCount | (Inherited from SoNode.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStringName | (Inherited from SoBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GLRender | (Inherited from SoNode.) | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoNode.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
IsBoundingBoxIgnoring | 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. | |
IsEqual | ||
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoNode.) | |
Search | (Inherited from SoNode.) | |
Set | 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. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
Write | (Inherited from SoNode.) |
Name | Description | |
---|---|---|
identifier | Specifies the parameter's integer name which is declared and used within low-level shading programs. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
name | Specifies the parameter's string name which is declared and used within high-level shading programs. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
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.
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);
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);
This is an abstract class. See the reference page of a derived class for the format and default values.