| SoUniformGridProjectionClipping Class |
Clips a volume with the depth map projection of a shape.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoTexture
OIV.Inventor.NodesSoTexture2
OIV.VolumeViz.NodesSoUniformGridClipping
OIV.VolumeViz.NodesSoUniformGridProjectionClipping
Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 9.9.36.0 (9.9.36.0)
SyntaxThe SoUniformGridProjectionClipping type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoUniformGridProjectionClipping | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| AllowPrequalifyFile | (Inherited from SoTexture2.) |
| Callback | (Inherited from SoTexture2.) |
| 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 SoUniformGridClipping.) |
| DoActionOnRTT | (Inherited from SoUniformGridClipping.) |
| 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). |
| GetBitmapFileType | Gets the texture file format. |
| GetBoundingBox | (Inherited from SoUniformGridClipping.) |
| 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.) |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoUniformGridClipping.) |
| 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. |
| IsAllowPrequalifyFile | (Inherited from SoTexture2.) |
| 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 field. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| LoadTexture | Loads the texture if the loadingMode field is set to MANUAL. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoUniformGridClipping.) |
| 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. |
| SetBitmapFileType | Sets the texture file format. |
| SetFinishLoadingCB(SoTexture2LoadingCallback) | Obsolete.
Use FinishLoadingCallback property instead.
Delegate invoked when finishing to load the texture.
(Inherited from SoTexture2.) |
| SetFinishLoadingCB(SoTexture2FinishLoadingDataCallback, Object) | Obsolete.
Use FinishLoadingCallback property instead.
(Inherited from SoTexture2.) |
| SetName | (Inherited from SoBase.) |
| SetOverride | Set the state of the override field. |
| SetStartLoadingCB(SoTexture2LoadingCallback) | Obsolete.
Use StartLoadingCallback property instead.
Delegate invoked when starting to load the texture.
(Inherited from SoTexture2.) |
| SetStartLoadingCB(SoTexture2StartLoadingDataCallback, Object) | Obsolete.
Use StartLoadingCallback property instead.
(Inherited from SoTexture2.) |
| 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 | |
|---|---|---|
 | axis | Height axis: X, Y, or Z. |
| blendColor | Color used for BLEND model. |
| borderColor | Defines border color used for border texture filtering. |
| clipAbove | Clip voxels above the surface. |
| clipBelow | Clip voxels below the surface. |
| enableBorder | Enables borders for textures. |
| enableCompressedTexture | Enables storage of textures on the graphics board in compressed form. |
| extent | Bounding box of the surface in 3D geometric coordinates. |
| filename | Name of the file from which to read texture image. |
| FinishLoadingCallback | Callback invoked when the texture is loaded and ready to use. |
| image | Contains an in-memory representation of the texture map. |
| internalFormat | (Inherited from SoTexture.) |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| loadingMode | Specifies the loading mode. |
| magFilter | Specifies the OpenGL magFilter. |
| maxAnisotropy | Specifies on a per-texture object basis, the maximum degree of anisotropy to account for in texture filtering. |
| minFilter | Specifies the OpenGL minFilter. |
| model | Specifies how to map texture onto surface. |
| renderToTextureProperty | Specifies an SoRenderToTextureProperty node containing a scene graph that will be rendered to create the texture image. |
| sceneGraph | Scene graph containing shapes to project on the orthogonal plane defined by axis field to generate the SoUniformGridClipping height map texture. |
| size | Obsolete. Obsoletesince Open Inventor 8000 Use SoUniformGridClipping.extent instead. |
| StartLoadingCallback | Callback invoked when starting to load the texture. |
| thickness | Defines a clipping thickness in the axis direction. |
| undefinedValue | Texels in the clipping texture with this value will clip all voxels above and below the surface. |
| useAutoMipmap | Obsolete. Sets OpenGL auto-mipmap generation (if supported). |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| wrapS | Indicates what to do when texture coordinates in the S (horizontal) direction lie outside the range 0-1. |
| wrapT | Indicates what to do when texture coordinates in the T (vertical) direction lie outside the range 0-1. |
RemarksThis class is an helper class derived from SoUniformGridClipping. It defines its clipping texture by the depth map of the given sceneGraph in the given axis orientation.
Notes:
Rendering the sceneGraph on top of the clipped volume might result in z-fighting artefacts due to depth precision. In order to avoid this issue it is necessary to use a SoPolygonOffset node before the geometry to render.
sceneGraph should not contain any draggers or manipulators because they will become part of the clipping texture and might lead to unwanted results. As a workaround, you can put draggers outside of sceneGraph, put an SoTransform inside your sceneGraph and connect it to your dragger.
If sceneGraph contains holes, you should set the minFilter and magFilter fields to NEAREST to avoid interpolation issues between holes and the true surface.
The inherited field SoUniformGridClipping.undefinedValue is set to the default depth (i.e. 1).
See SoUniformGridClipping for detailed behavior and limitations.
NOTE: node available since Open Inventor 8.6
FILE FORMAT/DEFAULT
UniformGridProjectionClipping {
| sceneGraph | NULL |
| axis | Y |
| extent | -1,0,-1 1,1,1 |
| filename | "" |
| image | 0 0 0 |
| wrapS | CLAMP_TO_EDGE |
| wrapT | CLAMP_TO_EDGE |
| model | MODULATE |
| enableCompressedTexture | false |
| blendColor | 0 0 0 |
| enableBorder | false |
| borderColor | 0 0 0 0 |
| maxAnisotropy | 1.0 |
| minFilter | AUTO |
| magFilter | AUTO |
| loadingMode | AUTO |
| useAutoMipmap | false |
| internalFormat | AUTO_INTERNAL_FORMAT |
| thickness | 0 |
| clipBelow | false |
| clipAbove | true |
See Also