| SoDepthOffset Class |
Property node that applies a depth offset.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoDepthOffset
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoDepthOffset type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoDepthOffset | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoNode.) |
 | ComputeNDCadjustment | Compute matrix NDCadjustment by scaling input matrix on z. |
| 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 SoNodeDoAction(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 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 | (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 | (Overrides SoNodeRayPick(SoRayPickAction).) |
| Search | (Overrides SoNodeSearch(SoSearchAction).) |
| 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. |
| SetupGlobalParameters | Use offset of DepthOffsetElement to setup : |
| 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 | |
|---|---|---|
 | IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| offset | Offset to apply to the projection matrix. |
| on | Enables depth offset. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node can be used to offset shapes that are co-planar, in order to resolve depth buffer artifacts, commonly called z-buffer "stitching".
The effect is similar to OIV.Inventor.Nodes.SoPolygonOffset but this node uses a different algorithm (based on Lengyel's method from Game Programming Gems and improved by VSG) in which the projection matrix is modified to offset subsequent geometry. As a result it has advantages over OIV.Inventor.Nodes.SoPolygonOffset in some cases. Specifically, OIV.Inventor.Nodes.SoDepthOffset applies its offset value to all types of geometry, not just polygons, and does not require any additional per-vertex calculations on the GPU.
The OIV.Inventor.Nodes.SoDepthOffset.offset value is accumulated in the traversal state. For example:
OIV.Inventor.Nodes.SoDepthOffset has two limitations. First, since it modifies the projection matrix during traversal, it may prevent building a render cache for part of the scene graph. Second, the offset does not take into account the depth slope of the geometry (as OIV.Inventor.Nodes.SoPolygonOffset does), so a larger offset may be required for geometry that is not perpendicular to the view vector (facing the camera).
The presence of a OIV.Inventor.Nodes.SoDepthOffset node in the scene graph causes depth buffer values to be different, even if 'offset' is equal to 0.
The render caching issue is easily handled, by adjusting your scene graph structure, just as you would for any non-cacheable node, to ensure that the actual shape nodes are cached even if the parent group node cannot cache: For example, using this scene graph structure:
instead of this one:
FILE FORMAT/DEFAULT
DepthOffset {
| offset | 0.001 |
| on | true |
ACTION BEHAVIOR
See Also