| SoGLCallback Class |
Provides custom OpenGL behavior during rendering actions.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoCallback
OIV.Inventor.NodesSoGLCallback
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoGLCallback type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoGLCallback | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoCallback.) |
| 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 | (Overrides SoCallbackDoAction(SoAction).) |
| 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 SoCallback.) |
| 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 SoCallback.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoCallback.) |
| 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 SoCallback.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoCallback.) |
| 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 SoCallback.) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoCallback.) |
| 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 SoCallback.) |
Properties| Name | Description | |
|---|---|---|
 | CallbackHandler | Sets pointer to callback function and user data. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node behaves exactly like an OIV.Inventor.Nodes.SoCallback except... the OIV.Inventor.Nodes.SoGLCallback node allows the application to make OpenGL calls during a render traversal. It is normally used to make OpenGL rendering calls (and any state setting calls needed for rendering).
OIV.Inventor.Nodes.SoGLCallback automatically calls glPushAttrib() to save the OpenGL state before executing the callback and then calls glPopAttrib() (restore) after executing the callback, ensuring that OpenGL state cannot leak outside the node.
Please note that this means an OIV.Inventor.Nodes.SoGLCallback node cannot modify the OpenGL state used for Open Inventor rendering. (This is a change since Open Inventor 10.0) You must use standard Open Inventor nodes to modify state for Open Inventor rendering. For example, use an OIV.Inventor.Nodes.SoViewport node to change the OpenGL viewport, use the OIV.Inventor.Nodes.SoDepthBuffer node to change the OpenGL depth buffer test and so on.
You can use this node to get values from the Open Inventor traversal state list using the OIV.Inventor.Elements.SoElement classes. For example, OIV.Inventor.Elements.SoLineWidthElement contains the current line width set by an OIV.Inventor.Nodes.SoDrawStyle node.
This node should not be used to do Open Inventor rendering. Open Inventor rendering calls should only be done using an SoCallBack node.
There is some "overhead" for rendering using OIV.Inventor.Nodes.SoGLCallback instead of Open Inventor nodes. Normal Open Inventor rendering is optimized in various ways to maximize GPU performance and to keep the GPU "busy". When an OIV.Inventor.Nodes.SoGLCallback node is traversed, Open Inventor must finish all current rendering, execute the application's OpenGL calls, then resume normal rendering.
Create the node:
SoGLCallback glCallbackNode = new SoGLCallback(); glCallbackNode.CallbackHandler = new SoGLCallback.CallbackCB( myGLCallback ); root.AddChild( glCallbackNode );
void myCallback( SoAction action ) { // Safe to call OpenGL functions }
FILE FORMAT/DEFAULT
GLCallback {
ACTION BEHAVIOR
OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoGetBoundingBoxAction, OIV.Inventor.Actions.SoPickAction Calls the specified delegatefor all actions.
 Note |
|---|
Node available since Open Inventor 10.0 |
See Also