Click or drag to resize
SoOffscreenVolumeRender Class

Extract data from an OIV.VolumeViz.Nodes.SoVolumeRender.

Inheritance Hierarchy

Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 10.11.2.0 (10.11.2.0)
Syntax
public abstract class SoOffscreenVolumeRender : SoNode

The SoOffscreenVolumeRender type exposes the following members.

Methods
  NameDescription
Public methodAffectsState

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

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoNode.)
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 SoNode.)
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 methodGetBoundingBox
(Inherited from SoNode.)
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 methodGetMaxBoxSize
Calls GetMaxBoxSize((OIV.Inventor.Misc.SoState ^)nullptr).
Public methodGetMaxBoxSize(SoState)

Returns the maximum boxSize that can be extract in one boxComputed for the current state.

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

reimplement GLRender behavior to launch computation when trigger touch

(Overrides SoNodeGLRender(SoGLRenderAction).)
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 methodIjkToXyzBox

Convert ijk box coordinates returned by boxComputed method to the bboxSceneGraph space.

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 flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
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 methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
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 methodSynchronousExtraction

Does extraction synchronously, whereas using trigger field will execute extraction on next redraw.

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 propertybboxSceneGraph

Head of the scene graph that defines the 3D off-screen scene cube to consider in world coordinates.

Public propertyboxSize

Resolution of the output data in the off-screen box.

Public propertycomponents

Components to get back from the offscreen render.

Public propertydataSpaceMatrix

This transformation is applied on the volume render texture coordinate during the extraction.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyopacityThreshold

During extraction, voxels with an opacity less than the specified value will be ignored Default is 0.

Public propertytrigger

Setting this field to true will start the off-screen rendering process.

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

Head of the scene graph that contains one or multiple VolumeRender node to render in 3D off-screen cube.

Top
Remarks

The OIV.VolumeViz.Nodes.SoOffscreenVolumeRender node extracts data by rendering one or more volumes (via OIV.VolumeViz.Nodes.SoVolumeRender) into a buffer that can then be used for different computation tasks.

Volumes of interest are specified by a subscenegraph in OIV.VolumeViz.Nodes.SoOffscreenVolumeRender.volumerenderSceneGraph.

The region to be extracted is the bounding box of the scene graph specified in the OIV.VolumeViz.Nodes.SoOffscreenVolumeRender.bboxSceneGraph field.

To implement an extraction, the application must derive a new class from OIV.VolumeViz.Nodes.SoOffscreenVolumeRender and implement :

  • the boxComputed method. This method is called with parameters that give access to information about the processed box.

  • the getNextSubBox method. This method must return subBox size smaller than getMaxBoxSize. We recommend to request subbox even smaller in order to get more parallelism between extraction processing (done on GPU) and application processing and reduce peak GPU memory resources used.

The resolution of the extraction is controlled by OIV.VolumeViz.Nodes.SoOffscreenVolumeRender.boxSize field. As extraction is done using GPU techniques, there is a size limit on the boxSize that can be extract in one call. This limit can be retreived through getMaxBoxSize call.

Limitations:

FILE FORMAT/DEFAULT

OIV.VolumeViz.Nodes.SoOffscreenVolumeRender {
volumerenderSceneGraph NULL
bboxSceneGraph NULL
boxSize (64, 64, 64)
trigger false
opacityThreshold 0
components ALPHA
}

See Also