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.1.0.0 (2024.1.0)

Syntax

C++

Copy

public class SoUniformShaderParameter : SoShaderParameter

Public Class SoUniformShaderParameter
	Inherits SoShaderParameter

public ref class SoUniformShaderParameter : public SoShaderParameter

type SoUniformShaderParameter =  
    class
        inherit SoShaderParameter
    end

The SoUniformShaderParameter type exposes the following members.

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Inherited from SoNode.)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	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). (Inherited from SoFieldContainer.)
	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. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	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.)
	GetBoundingBox	(Inherited from SoNode.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoNode.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetPrimitiveCount	(Inherited from SoNode.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	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. (Inherited from SoFieldContainer.)
	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. (Inherited from SoNode.)
	IsEqual
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	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. (Inherited from SoFieldContainer.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoNode.)

Top

Properties

	Name	Description
	identifier	Specifies the parameter's integer name which is declared and used within low-level shading programs. (Inherited from SoShaderParameter.)
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	name	Specifies the parameter's string name which is declared and used within high-level shading programs. (Inherited from SoShaderParameter.)
	UserData	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:

Copy

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:

Copy

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