SoVolumeReader.GetSubVolumeInfo Method

SoVolumeReaderGetSubVolumeInfo Method

This method, if implemented, will be used by VolumeViz to know what the reader wants to do and what it is able to do.

Namespace: OIV.LDM.Readers
Assembly: OIV.LDM (in OIV.LDM.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

public virtual bool GetSubVolumeInfo(
	SbBox3i32 subVolume,
	SbVec3i32 requestedSubsampleLevel,
	out SbVec3i32 actualSubsampleLevel,
	out SoVolumeReaderCopyPolicies policy
)

Public Overridable Function GetSubVolumeInfo ( 
	subVolume As SbBox3i32,
	requestedSubsampleLevel As SbVec3i32,
	<OutAttribute> ByRef actualSubsampleLevel As SbVec3i32,
	<OutAttribute> ByRef policy As SoVolumeReaderCopyPolicies
) As Boolean

public:
virtual bool GetSubVolumeInfo(
	[InAttribute] SbBox3i32 subVolume, 
	[InAttribute] SbVec3i32 requestedSubsampleLevel, 
	[OutAttribute] SbVec3i32% actualSubsampleLevel, 
	[OutAttribute] SoVolumeReaderCopyPolicies% policy
)

abstract GetSubVolumeInfo : 
        subVolume : SbBox3i32 * 
        requestedSubsampleLevel : SbVec3i32 * 
        actualSubsampleLevel : SbVec3i32 byref * 
        policy : SoVolumeReaderCopyPolicies byref -> bool 
override GetSubVolumeInfo : 
        subVolume : SbBox3i32 * 
        requestedSubsampleLevel : SbVec3i32 * 
        actualSubsampleLevel : SbVec3i32 byref * 
        policy : SoVolumeReaderCopyPolicies byref -> bool

Parameters

subVolume: Type: OIV.InventorSbBox3i32
requestedSubsampleLevel: Type: OIV.InventorSbVec3i32
actualSubsampleLevel: Type: OIV.InventorSbVec3i32
policy: Type: OIV.LDM.ReadersSoVolumeReaderCopyPolicies

Return Value

Type: Boolean

Remarks

VolumeViz will specify the real subvolume of the brick (the size may not be a power of 2 if the brick is on the border) and the subSampling level it wants to use. The reader, based on those inputs, will respond by telling VolumeViz exactly at what subSampling level it will return the data (by setting the actualSubSampleLevel parameter) and who will be in charge of managing the memory (by setting the policy parameter). The method returns FALSE if GetSubVolume is not used.

Reference

SoVolumeReader Class

OIV.LDM.Readers Namespace