| SoRenderToTextureProperty Class |
Class for creating a texture by rendering a scene graph.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoRenderToTextureProperty
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
SyntaxThe SoRenderToTextureProperty type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoRenderToTextureProperty | Initializes a new instance of the SoRenderToTextureProperty class |
Methods| 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. |
| GetGLRenderAction | Returns the render action used for rendering the scene. |
| GetGraphicConfigTemplate | Obsolete. |
| 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 | (Overrides SoNodeGLRender(SoGLRenderAction).) |
| 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. |
| 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. |
| SetContextForSharing | Obsolete. |
| SetGLRenderAction | Specifies a custom render action to use for rendering the scene. |
| SetGraphicConfigTemplate | Obsolete. |
| 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.) |
Properties| Name | Description | |
|---|---|---|
 | backgroundColor | Background color used when rendering the scene graph. |
| component | Specifies the type of component(s) for the rendering. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| node | Specifies the scene graph(s) (OIV.Inventor.Nodes.SoNode) to be rendered into the texture. |
| path | Specifies the scene graph(s) (OIV.Inventor.SoPath) to be rendered into the texture. |
| size | Size in pixels of the rendered texture. |
| trigger | Trigger field to render the scene into the Pbuffer. |
| updatePolicy | Specifies the policy for rendering to the texture. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis class is used to define an image for texture mapping which is created by rendering a scene graph.
It can be used with the classes OIV.Inventor.Nodes.SoTexture2 and OIV.Inventor.Nodes.SoTextureCubeMap. Create the OIV.Inventor.Nodes.SoRenderToTextureProperty node and assign it to the renderToTextureProperty field of the texture mapping node.
The OIV.Inventor.Nodes.SoRenderToTarget node can also be used to create texture images.
One of the two fields, node or path, must be defined.
The scene graph should normally contain a camera and at least one light. Unlike OIV.Inventor.Nodes.SoRenderToTarget, the children of OIV.Inventor.Nodes.SoRenderToTextureProperty do not inherit the camera, lights, etc from the main scene graph.
Note that the default image size is 0,0 (effectively disables rendering).
FILE FORMAT/DEFAULT
RenderToTextureProperty {
| node | [] |
| path | "" |
| updatePolicy | WHEN_NEEDED |
| backgroundColor | 0 0 0 |
| size | 0 0 |
| component | RGB |
See Also