Click or drag to resize
SoInstanceParameter Class

Per-instance parameter node storing a buffer object.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoInstanceParameter : SoVertexShaderParameterBufferObject

The SoInstanceParameter type exposes the following members.

Constructors
  NameDescription
Public methodSoInstanceParameter

Constructor.

Top
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 methodStatic memberCreatePredefinedParameter(SoInstanceParameterPredefinedParameters, SoBufferObject)
Calls CreatePredefinedParameter(paramKey, values, System.Convert.ToUInt32(1)).
Public methodStatic memberCreatePredefinedParameter(SoInstanceParameterPredefinedParameters, SoBufferObject, UInt32)

Creates an instance parameter object for one of the predefined attribute names.

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 methodStatic memberGetPredefinedParameterName

Returns the predefined instance parameter name for the specified paramKey.

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 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 methodSetPredefinedParameterName

Sets the name field to the string corresponding to the given paramKey.

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 propertycomponents

Specifies the number of components per generic vertex parameter.

(Inherited from SoVertexShaderParameterBufferObject.)
Public propertydivisor

This field modifies the rate at which values advance during multiple instance rendering.

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 propertyoffset

Offset in bytes to the first parameter within the buffer.

(Inherited from SoVertexShaderParameterBufferObject.)
Public propertyshouldBeNormalized

Specifies if the fixed-point data in the buffer object should be normalized when they are accessed.

(Inherited from SoVertexShaderParameterBufferObject.)
Public propertystride

Specifies the byte offset between consecutive generic vertex parameter.

(Inherited from SoVertexShaderParameterBufferObject.)
Public propertytype

Specifies the data type from the class OIV.Inventor.SbDataType of each generic vertex parameter component.

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

Specifies the parameter's values.

(Inherited from SoVertexShaderParameterBufferObject.)
Top
Remarks

This node allows the application to provide a per-instance parameter of any type, using an OIV.Inventor.Devices.SoBufferObject. It is used with the OIV.Inventor.Nodes.SoMultipleInstance node.

Some predefined parameter names can be used for common instance parameters like position, rotation and scale factor. Parameter objects with these names are automatically managed and are recognized and used by the default shaders. Applications can define additional parameter objects to be used by custom shaders.

See the base classes OIV.Inventor.Nodes.SoShaderParameter, OIV.Inventor.Nodes.SoVertexShaderParameter and OIV.Inventor.Nodes.SoVertexShaderParameterBufferObject for more details.

Note: Unlike OIV.Inventor.Nodes.SoVertexShaderParameter, instances of this node must be added to the parameters field of an OIV.Inventor.Nodes.SoMultipleInstance node, not directly in the scene graph.

FILE FORMAT/DEFAULT

InstanceParameter {
name ""
identifier 0
value NULL
components 4
type OIV.Inventor.SbDataType.DataTypes.FLOAT
stride 0
shouldBeNormalized false
divisor 1
}

Note Note

Node available since Open Inventor 9.5

See Also