| SoVolumeRenderingPhysicalQuality Class |
Volume rendering physical quality property node.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.VolumeViz.NodesSoVolumeRenderingPhysicalQuality
Namespace: OIV.VolumeViz.Nodes
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe SoVolumeRenderingPhysicalQuality type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoVolumeRenderingPhysicalQuality | Initializes a new instance of the SoVolumeRenderingPhysicalQuality class |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoNode.) |
| 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 | (Inherited from SoNode.) |
| 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. |
| 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 SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | blurFactor | This value controls the intensity of the blurring for the Depth Of Field effect. |
| enableDepthOfField | Enables a 'Depth of Field' effect on the volume. |
| environmentMap | Specifies which Environment map is used. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| predefinedMaterial | Specifies a material from a list of predefined ones. |
| shadingStyle | Specifies which shading style is applied to the volume. |
| shadowsStyle | Specifies which kind of shadows to compute for the volume. |
| toneMapping | Specifies which tone mapping algorithm to apply. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node is intended to be used when one wants to achieve "out of the box" high quality volume rendering. It works the same way as a OIV.VolumeViz.Nodes.SoVolumeRenderingQuality node, in the sense that it causes subsequent OIV.VolumeViz.Nodes.SoVolumeRender nodes to be drawn with different rendering effects and/or levels of quality, the difference being that the OIV.VolumeViz.Nodes.SoVolumeRenderingQuality fields are not exposed in this node and are internally pre-selected to provide the highest possible quality:
The OIV.VolumeViz.Nodes.SoVolumeRenderingQuality fields that are internally activated are:
OIV.VolumeViz.Nodes.SoVolumeRenderingQuality.preIntegrated = true
OIV.VolumeViz.Nodes.SoVolumeRenderingQuality.ambientOcclusion = true
OIV.VolumeViz.Nodes.SoVolumeRenderingQuality.deferredLighting = true
The presence of this node in the scenegraph also forces subsequent OIV.VolumeViz.Nodes.SoVolumeRender nodes to be drawn with OIV.VolumeViz.Nodes.SoVolumeRender.samplingAlignment set to OIV.VolumeViz.Nodes.SoVolumeRender.SamplingAlignments.BOUNDARY_ALIGNED.
Note that, unlike OIV.VolumeViz.Nodes.SoVolumeRenderingQuality, this node does not support customization of VolumeViz shaders.
The fields exposed in this node provide control over effects that are not present in the OIV.VolumeViz.Nodes.SoVolumeRenderingQuality node. These effects include:
Physically Based Lighting
Ray-Traced Shadows
Depth of Field
Physically Based Lighting
The Physically Based Lighting effect provides lighting using an advanced BRDF model. It can be seen as an enhanced version of the regular deferred lighting. In particular, it shows the same behavior regarding the current OIV.Inventor.Nodes.SoMaterial on the state and has the same limitations. See OIV.VolumeViz.Nodes.SoVolumeRenderingQuality.deferredLighting for a detailed list of limitations. In addition to regular deferred lighting, this effect supports HDR environment mapping and several cubemap textures are provided (see OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.environmentMap). The field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.toneMapping is provided to select the Tone Mapping algorithm used to remap HDR values to low range values. A predefined material that will be applied to the shape can also be selected using the field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.predefinedMaterial. Any material set between this node and the OIV.VolumeViz.Nodes.SoVolumeRender node in the scenegraph will override this predefined material. Note that, just like with regular deferred lighting, the material properties will affect the lighting, and the OIV.Inventor.Nodes.SoMaterial.diffuseColor will be mixed with the voxel colors using a component-wise multiplication. Finally, the field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.shadingStyle allows to switch between this type of lighting and regular deferred lighting.
Ray-Traced Shadows
The Ray-Traced Shadows effect computes shadows inside the volume using a ray-marching based algorithm. This effect is activated and parameterized just like regular shadows using the OIV.Inventor.Nodes.SoShadowGroup node. The OIV.Inventor.Nodes.SoShadowGroup fields taken into account for this effect are OIV.Inventor.Nodes.SoShadowGroup.isActive, OIV.Inventor.Nodes.SoShadowGroup.intensity and OIV.Inventor.Nodes.SoShadowGroup.quality. This type of shadows supports OIV.LDM.Nodes.SoROI clipping, but does not support OIV.Inventor.Nodes.SoClipPlane, OIV.VolumeViz.Nodes.SoVolumeClippingGroup, OIV.VolumeViz.Nodes.SoUniformGridClipping or OIV.VolumeViz.Nodes.SoUniformGridProjectionClipping. Note that this effect has a huge impact on performance. The field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.shadowsStyle allows to switch between this type of shadows and regular shadows.
Depth of Field
Depth Of Field is a "cinematic" effect that adds blur on regions far from the focal point of the camera. The focal point is typically the center of the scene bounding box, causing regions close to the camera and far from the camera to be blurred. The focal point is specified by the field OIV.Inventor.Nodes.SoCamera.focalDistance of the current camera. Only OIV.VolumeViz.Nodes.SoVolumeRender nodes are affected by the blurring. The field OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.enableDepthOfField is used to switch it on and off, while the OIV.VolumeViz.Nodes.SoVolumeRenderingPhysicalQuality.blurFactor field controls the amount of blur induced by this effect.
FILE FORMAT/DEFAULT
VolumeRenderingPhysicalQuality {
 Note |
|---|
Node available since Open Inventor 9.8 |
See Also