Click or drag to resize
SoUniformGridProjectionClipping Class

Clips a volume with the depth map projection of a shape.

Inheritance Hierarchy

Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 2024.1.1.0 (2024.1.1)
Syntax
public class SoUniformGridProjectionClipping : SoUniformGridClipping

The SoUniformGridProjectionClipping type exposes the following members.

Constructors
  NameDescription
Public methodSoUniformGridProjectionClipping

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodAllowPrequalifyFile
(Inherited from SoTexture2.)
Public methodCallback
(Inherited from SoTexture2.)
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 methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoUniformGridClipping.)
Public methodDoActionOnRTT
(Inherited from SoUniformGridClipping.)
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 methodGetBitmapFileType

Gets the texture file format.

(Inherited from SoTexture.)
Public methodGetBoundingBox
(Inherited from SoUniformGridClipping.)
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 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
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 methodIsAllowPrequalifyFile
(Inherited from SoTexture2.)
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 field.

(Inherited from SoTexture.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodLoadTexture

Loads the texture if the OIV.Inventor.Nodes.SoTexture2.loadingMode field is set to MANUAL.

(Inherited from SoTexture2.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoUniformGridClipping.)
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 methodSetBitmapFileType

Sets the texture file format.

(Inherited from SoTexture.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Set the state of the override field.

(Inherited from SoTexture.)
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 propertyaxis

Height axis: X, Y, or Z.

(Inherited from SoUniformGridClipping.)
Public propertyblendColor

Color used for BLEND model.

(Inherited from SoTexture.)
Public propertyborderColor

Defines border color used for border texture filtering.

(Inherited from SoTexture.)
Public propertyclipAbove

Clip voxels above the surface.

(Inherited from SoUniformGridClipping.)
Public propertyclipBelow

Clip voxels below the surface.

(Inherited from SoUniformGridClipping.)
Public propertyenableBorder

Enables borders for textures.

(Inherited from SoTexture.)
Public propertyenableCompressedTexture

Enables storage of textures on the graphics board in compressed form.

(Inherited from SoTexture.)
Public propertyextent

Bounding box of the surface in 3D geometric coordinates.

(Inherited from SoUniformGridClipping.)
Public propertyfilename

Name of the file from which to read texture image.

(Inherited from SoTexture2.)
Public propertyFinishLoadingCallback

Callback invoked when the texture is loaded and ready to use.

(Inherited from SoTexture2.)
Public propertyimage

Contains an in-memory representation of the texture map.

(Inherited from SoTexture2.)
Public propertyinternalFormat

Internal format for texture storage.

(Inherited from SoTexture.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyloadingMode

Specifies the loading mode.

(Inherited from SoTexture2.)
Public propertymagFilter

Specifies the OpenGL magFilter.

(Inherited from SoTexture.)
Public propertymaxAnisotropy

Specifies on a per-texture object basis, the maximum degree of anisotropy to account for in texture filtering.

(Inherited from SoTexture.)
Public propertyminFilter

Specifies the OpenGL minFilter.

(Inherited from SoTexture.)
Public propertymodel

Specifies how to map texture onto surface.

(Inherited from SoTexture.)
Public propertyrenderToTextureProperty

Specifies an OIV.Inventor.Nodes.SoRenderToTextureProperty node containing a scene graph that will be rendered to create the texture image.

(Inherited from SoTexture2.)
Public propertysceneGraph

Scene graph containing shapes to project on the orthogonal plane defined by axis field to generate the OIV.VolumeViz.Nodes.SoUniformGridClipping height map texture.

Public propertysize Obsolete.
(Inherited from SoUniformGridClipping.)
Public propertyStartLoadingCallback

Callback invoked when starting to load the texture.

(Inherited from SoTexture2.)
Public propertythickness

Defines a clipping thickness in the axis direction.

(Inherited from SoUniformGridClipping.)
Public propertyundefinedValue

Texels in the clipping texture with this value will clip all voxels above and below the surface.

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

Indicates what to do when texture coordinates in the S (horizontal) direction lie outside the range 0-1.

(Inherited from SoTexture.)
Public propertywrapT

Indicates what to do when texture coordinates in the T (vertical) direction lie outside the range 0-1.

(Inherited from SoTexture2.)
Top
Remarks

This class is an helper class derived from OIV.VolumeViz.Nodes.SoUniformGridClipping. It defines its clipping texture by the depth map of the given OIV.VolumeViz.Nodes.SoUniformGridProjectionClipping.sceneGraph in the given axis orientation.

Notes:

See OIV.VolumeViz.Nodes.SoUniformGridClipping for detailed behavior and limitations.

Note 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