maxstAR::BackgroundRenderer Class Reference

Do background rendering. Background rendering includes camera image, feature point, slam initialization progress bar, watermark, surface mesh. More...

#include <BackgroundRenderer.h>

Collaboration diagram for maxstAR::BackgroundRenderer:

Public Types
enum	RenderingOption {   FEATURE_RENDERER = 0x01, PROGRESS_RENDERER = 0x02, AXIS_RENDERER = 0x04, SURFACE_MESH_RENDERER = 0x08,   VIEW_FINDER_RENDERER = 0X10 }
	Additional rendering option. Slam feature point, Surface mesh, etc. 0x01 : Feature point rendering.(Object Tracker and Visual SLAM) 0x02 : Creating slam map progress rendering.(Visual SLAM only) 0x04 : Slam initial pose coordinate rendering.(Code Tracker is not supported) 0x08 : Slam surface mesh rendering.(Object Tracker and Visual SLAM) 0x10 : Scan view finder rendering.(Code Tracker Only) More...

Public Member Functions
virtual void	setRenderingOption (int option=0)=0
	Set background rendering option. Option can be multiple (FEATURE_RENDERER | SURFACE_MESH_RENDERER) Should be called after initRendering. More...
virtual void	setClippingPlane (float nearClipPlane, float farClipPlane)=0
	Set view frustrum's near and far clipping plane distance. More...
virtual BackgroundTexture *	getBackgroundTexture ()=0
	Get texture for background rendering. More...
virtual void	begin (BackgroundTexture *texture)=0
	Prepare background rendering to BackgroundTexture. More...
virtual void	renderBackgroundToTexture ()=0
	Render background to BackgroundTexture. Background can include camera image, feature point, etc. More...
virtual void	end ()=0
	End background rendering to BackgroundTexture. More...

Static Public Member Functions
static BackgroundRenderer *	getInstance ()
	Get BackgroundRenderer instance. More...

Detailed Description

Do background rendering. Background rendering includes camera image, feature point, slam initialization progress bar, watermark, surface mesh.

Member Enumeration Documentation

RenderingOption

enum maxstAR::BackgroundRenderer::RenderingOption

Additional rendering option. Slam feature point, Surface mesh, etc. 0x01 : Feature point rendering.(Object Tracker and Visual SLAM) 0x02 : Creating slam map progress rendering.(Visual SLAM only) 0x04 : Slam initial pose coordinate rendering.(Code Tracker is not supported) 0x08 : Slam surface mesh rendering.(Object Tracker and Visual SLAM) 0x10 : Scan view finder rendering.(Code Tracker Only)

Enumerator
FEATURE_RENDERER
PROGRESS_RENDERER
AXIS_RENDERER
SURFACE_MESH_RENDERER
VIEW_FINDER_RENDERER

Member Function Documentation

begin()

virtual void maxstAR::BackgroundRenderer::begin ( BackgroundTexture *  texture )

pure virtual

Prepare background rendering to BackgroundTexture.

end()

virtual void maxstAR::BackgroundRenderer::end ( )

pure virtual

End background rendering to BackgroundTexture.

getBackgroundTexture()

virtual BackgroundTexture* maxstAR::BackgroundRenderer::getBackgroundTexture ( )

pure virtual

Get texture for background rendering.

Returns

BackgroundTexture instance if texture created

getInstance()

static BackgroundRenderer* maxstAR::BackgroundRenderer::getInstance ( )

static

Get BackgroundRenderer instance.

renderBackgroundToTexture()

virtual void maxstAR::BackgroundRenderer::renderBackgroundToTexture ( )

pure virtual

Render background to BackgroundTexture. Background can include camera image, feature point, etc.

setClippingPlane()

virtual void maxstAR::BackgroundRenderer::setClippingPlane ( float  nearClipPlane, float  farClipPlane  )

pure virtual

Set view frustrum's near and far clipping plane distance.

Parameters

nearClipPlane	near clipping plane distance
farClipPlane	far end of camera frustum over which background is rendered

setRenderingOption()

virtual void maxstAR::BackgroundRenderer::setRenderingOption ( int  option = 0 )

pure virtual

Set background rendering option. Option can be multiple (FEATURE_RENDERER | SURFACE_MESH_RENDERER) Should be called after initRendering.

Parameters

1	: Feature point 2 : Slam initializing progress bar 4 : Slam pose coordinate 8 : Slam surface mesh

---

The documentation for this class was generated from the following file:

• E:/Workspace/MaxstARSDK/MaxstAR/include/BackgroundRenderer.h