RenderQueue

Summary

RenderQueue provides render queueing functionality. You simply pass all RENDER_PARAMS to this object and efficient streaming and final rendering calls automatically happen. Specify an IRQFrameListener to recieve events when a frame is ready for display. Call RenderFinal() when you're sure you're done sending rendering parameters for a while (such as when the user releases the mouse after a drag operation).

o	ApplyTransformToQueue

o	BreakStreaming

o	ClearQueue

o	DecRef (C++)

FastSwap

o	GetAdaptiveJPEGStatus (C++)

o	GetAndResetModifiedTFs (no links)

o	GetCurvedReformat

o	GetMaximumFrameRate

o	GetNID() (Java only)

o	GetRawFrameReadyCallbackEnabled (C++ -- no link)

o	GetRenderEngineContext

o	GetRenderEngineType

o	GetRenderParams

o	GetRenderParamsCached

o	GetTransferFunction

o	GetTransferFunctionCached

o	hdrcRenderQueue (Java constructor)

o	IncRef (C++)

Init

Init4D

o	isConvertedFrameFinal (Java)

o	IsFinalShown

o	IsRendering

o	ReleaseSessionResources

Render

o	RenderFinal

o	SetAdaptiveJPEGParameters / setAdaptiveJPEGCompressionParam

o	SetAdaptiveJPEGStatus (C++)

o	SetAutonavigating

o	SetCompressionType

o	SetCurvedMPRPath

o	SetDontRenderWhileDisplaying

o	SetFinalCompressionType

o	SetFinalRenderTimeout

o	SetFrameListener

o	SetImageAllocator (C++)

o	SetLocalRendering

o	SetMaximumFrameRate

o	SetNoFinalRenders

o	SetParameterIgnoringEnabled

o	SetRawFrameReadyCallbackEnabled

o	SetRenderEngineContext

o	SetRenderParams

o	SetStereoMode (no link)

o	SetTransferFunction

o	setUseAdaptiveJPEGCompression (Java)

o	SetViewMode

o	StopThreads

o	UpdateImage

o	UpdateRenderParamMembers (C++)

o	WaitForParamsToBeSet

Methods

IRenderQueue::ApplyTransformToQueue()

C++

virtual signed int IRenderQueue::ApplyTransformToQueue ( MATRIX44D * trans )

pure virtual

Deprecated. Just use SetRenderParams().

Parameters

trans MATRIX44D

com.fovia.hdrc.hdrcRenderQueue.applyTransformToQueue()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::BreakStreaming()

C++

virtual signed int IRenderQueue::BreakStreaming ( )

pure virtual

Requests that streaming break at the next possible opportunity. Normally, the queue will wait a little while before breaking streaming to see if more params come in. This will make sure that wait does not happen.

com.fovia.hdrc.hdrcRenderQueue.breakStreaming()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::ClearQueue()

C++

virtual signed int IRenderQueue::ClearQueue ( )

pure virtual

Clears any queued up render param changes. They will be discarded and the information will be lost.

com.fovia.hdrc.hdrcRenderQueue.clearQueue()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::DecRef()

C++

virtual signed int IRenderQueue::DecRef ( )

pure virtual

Decreases the reference count on this object by 1. If the reference count reaches 0, the object is deallocated.

Implements IRoot.

IRenderQueue::FastSwap()

C++

virtual signed int IRenderQueue::FastSwap	(	IVolumeDataContext *	volumeData,
		IOctreeContext *	octree
	)

pure virtual

Requests a fast swap of the current volume to another. The new volume must be the same dimension, orientation, spacing, and skew.

Parameters

volumeData
octree

com.fovia.hdrc.hdrcRenderQueue.fastSwap()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetAdaptiveJPEGStatus()

C++

virtual signed int IRenderQueue::GetAdaptiveJPEGStatus ( h_boolean * status ) [pure virtual]

Gets the status of adaptive JPEG quality for interactive rendering.

IRenderQueue::getAndResetModifiedTFs()

C++

#MERGE Merge/hdvr_cpp_x.html

MISSING DOXYGEN

com.fovia.hdrc.hdrcRenderQueue.GetAndResetModifiedTFs()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetCurvedReformat()

C++

virtual signed int IRenderQueue::GetCurvedReformat	(	IVolumeDataContext **	pData,
		const h_uint32	numProjPlanesPerSlice,
		const h_uint32	numSlices,
		const h_uint32	ppWidth,
		const h_uint32	ppHeight,
		const h_uint32	measurementSlice,
		const h_float32	Zoom,
		MATRIX44D **	arrProjPlanes,
		const ENUM_CURVED_MPR_TYPE	type
	)		`[pure virtual]`

This will not go through the queuing process. You MUST make sure you're actually in curved MPR mode before calling this function. To ensure this, call WaitForParamsToBeSet() after setting the render type.

Parameters:

pData	The address of the IVolumeDataContext pointer that will get the location of the newly created volume.
numProjPlanesPerSlice	int
numSlices	int
ppWidth	int
ppHeight	int
measurementSlice	The index of the slice that can be used for accurate measurement. For accurate measurement on other slices, it is up to the user to understand the relationship between the input data and the output volume.
Zoom	float
arrProjPlanes	MATRIX44D**
type	int

Returns:: hdrcVolumeDataContext

com.fovia.hdrc.hdrcRenderQueue.getCurvedReformat()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetMaximumFrameRate()

C++

virtual signed int IRenderQueue::GetMaximumFrameRate ( h_uint32 * pFPS ) [pure virtual]

Returns the current max FPS. See SetMaximumFrameRate() for details.

com.fovia.hdrc.hdrcRenderQueue.getMaximumFrameRate()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetRawFrameReadyCallbackEnabled()

C++

#MERGE Merge/hdvr_cpp_x.html

MISSING DOXYGEN

com.fovia.hdrc.hdrcRenderQueue.getRawFrameReadyCallbackEnabled()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetRenderEngineContext()

C++

virtual signed int IRenderQueue::GetRenderEngineContext ( IRenderEngineContext ** pREC )

pure virtual

Returns the render engine context associated with this queue.

Parameters

pREC	IRenderEngineContext A pointer to the IRenderEngineContext* that will receive the context.

Implements IRenderParamsReceiver.

com.fovia.hdrc.hdrcRenderQueue.getRenderEngineContext()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetRenderEngineType()

C++

virtual signed int IRenderQueue::GetRenderEngineType ( ENUM_RENDER_TYPE * pRT )

pure virtual

Returns the render engine type associated with this queue.

com.fovia.hdrc.hdrcRenderQueue.getRenderEngineType()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetRenderParams()

C++

virtual signed int IRenderQueue::GetRenderParams ( RENDER_PARAMS * pRP )

pure virtual

Returns the current state of the engine in a RENDER_PARAMS structure.

Parameters

pRP	Will be filled with the parameters

Implements IRenderParamsReceiver.

virtual signed int IRenderQueue::GetRenderParamsEx	(	RENDER_PARAMS *	pRP,
		const h_boolean	bIncludeQueuedParams
	)		`[pure virtual]`

Returns the current state of the engine in a RENDER_PARAMS structure.

Parameters:

bIncludeQueuedParams	Set to HT_TRUE if you want to include the RENDER_PARAMS currently queued to be sent to the server.
pRP	Will be filled with the parameters

Implements IRenderParamsReceiver.

com.fovia.hdrc.hdrcRenderQueue.getRenderParams()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetRenderParamsCached()

C++

virtual signed int IRenderQueue::GetRenderParamsCached ( RENDER_PARAMS * pRP )

pure virtual

Gets the current RENDER_PARAMS as the queue knows them without sending a request to the server for engine state. This is almost always the preferred method of getting the RENDER_PARAMS.

Implements IRenderParamsReceiver.

com.fovia.hdrc.hdrcRenderQueue.getRenderParamsCached()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetTransferFunction()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.getTransferFunction()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::GetTransferFunctionCached()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.getTransferFunctionCached()

Java/.NET

#MERGE Merge/hdvr_java_x.html

com.fovia.hdrc.hdrcRenderQueue.hdrcRenderQueue()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::IncRef()

C++

#MERGE Merge/hdvr_cpp_x.html

IRenderQueue::Init()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.init()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::Init4D()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.init4D()

Java/.NET

#MERGE Merge/hdvr_java_x.html

com.fovia.hdrc.hdrcRenderQueue.isConvertedFrameFinal()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::IsFinalShown()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.isFinalShown()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::IsRendering()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.isRendering()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::ReleaseSessionResources()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.releaseSessionResources()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::Render()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.render()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::RenderFinal()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.renderFinal()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetAdaptiveJPEGParameters()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setAdaptiveJPEGCompressionParam()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetAdaptiveJPEGStatus()

C++

#MERGE Merge/hdvr_cpp_x.html

IRenderQueue::SetAutonavigating()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setAutonavigating()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetCompressionType()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setCompressionType()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetCurvedMPRPath()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setCurvedMPRPath()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetDontRenderWhileDisplaying()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setDontRenderWhileDisplaying()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetFinalCompressionType()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setFinalCompressionType()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetFinalRenderTimeout()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setFinalRenderTimeout()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetFrameListener()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setFrameListener()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetImageAllocator()

C++

#MERGE Merge/hdvr_cpp_x.html

IRenderQueue::SetLocalRendering()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setLocalRendering()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetMaximumFrameRate()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setMaximumFrameRate()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetNoFinalRenders()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setNoFinalRenders()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetParameterIgnoringEnabled()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setParameterIgnoringEnabled()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetRawFrameReadyCallbackEnabled()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setRawFrameReadyCallbackEnabled()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetRenderEngineContext()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setRenderEngineContext()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetRenderParams()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setRenderParams()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetStereoMode()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setStereoMode()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetTransferFunction()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setTransferFunction()

Java/.NET

#MERGE Merge/hdvr_java_x.html

com.fovia.hdrc.hdrcRenderQueue.setUseAdaptiveJPEGCompression()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::SetViewMode()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.setViewMode()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::StopThreads()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.stopThreads()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::UpdateImage()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.updateImage()

Java/.NET

#MERGE Merge/hdvr_java_x.html

IRenderQueue::UpdateRenderParamMembers()

C++

#MERGE Merge/hdvr_cpp_x.html

IRenderQueue::WaitForParamsToBeSet()

C++

#MERGE Merge/hdvr_cpp_x.html

com.fovia.hdrc.hdrcRenderQueue.waitForParamsToBeSet()

Java/.NET

#MERGE Merge/hdvr_java_x.html

Doxygen Links

Complete details of member variables and class names are available in the source level documentation available from these links to Doxygen.

C++	IRenderQueue
Java / .NET	hdrcRenderQueue