MaxstARSDK
All Classes Files Functions Variables Enumerations Enumerator Macros
MasBackgroundRenderer Class Reference

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

#import <MasBackgroundRenderer.h>

Inheritance diagram for MasBackgroundRenderer:
Inheritance graph
Collaboration diagram for MasBackgroundRenderer:
Collaboration graph

Instance Methods

(void) - setRenderingOption:
 Set background rendering option. Should be called after initRendering. More...
 
(void) - setClippingPlane:Far:
 Set view frustrum's near and far clipping plane distance. More...
 
(MasBackgroundTexture *) - getBackgroundTexture
 Get texture for background rendering. More...
 
(void) - begin:
 Prepare background rendering to BackgroundTexture. More...
 
(void) - renderBackgroundToTexture
 Render background to BackgroundTexture. Background can include camera image, feature point, etc. More...
 
(void) - end
 End background rendering to BackgroundTexture. More...
 

Protected Types

enum  MasRenderingOption : NSUInteger {
  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. FEATURE_RENDERER Feature point rendering.(Object Tracker and Visual SLAM) PROGRESS_RENDERER Creating slam map progress rendering.(Visual SLAM only) AXIS_RENDERER Slam initial pose coordinate rendering.(Code Tracker is not supported) SURFACE_MESH_RENDERER Slam surface mesh rendering.(Object Tracker and Visual SLAM) VIEW_FINDER_RENDERER Scan view finder rendering.(Code Tracker Only) More...
 

Detailed Description

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

Member Enumeration Documentation

◆ MasRenderingOption

- (enum MasRenderingOption) :
protected

Additional rendering option. Slam feature point, Surface mesh, etc. FEATURE_RENDERER Feature point rendering.(Object Tracker and Visual SLAM) PROGRESS_RENDERER Creating slam map progress rendering.(Visual SLAM only) AXIS_RENDERER Slam initial pose coordinate rendering.(Code Tracker is not supported) SURFACE_MESH_RENDERER Slam surface mesh rendering.(Object Tracker and Visual SLAM) VIEW_FINDER_RENDERER Scan view finder rendering.(Code Tracker Only)

Enumerator
FEATURE_RENDERER 
PROGRESS_RENDERER 
AXIS_RENDERER 
SURFACE_MESH_RENDERER 
VIEW_FINDER_RENDERER 

Method Documentation

◆ begin:()

- (void) begin: (MasBackgroundTexture *)  texture

Prepare background rendering to BackgroundTexture.

Parameters
textureget getBackgroundTexture Method

◆ end()

- (void) end

End background rendering to BackgroundTexture.

◆ getBackgroundTexture()

- (MasBackgroundTexture *) getBackgroundTexture

Get texture for background rendering.

Returns
MasBackgroundTexture instance if texture created

◆ renderBackgroundToTexture()

- (void) renderBackgroundToTexture

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

◆ setClippingPlane:Far:()

- (void) setClippingPlane: (float)  nearClipPlane
Far: (float)  farClipPlane 

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

Parameters
nearClipPlanenear clipping plane distance
farClipPlanefar end of camera frustum over which background is rendered

◆ setRenderingOption:()

- (void) setRenderingOption: (MasRenderingOption option

Set background rendering option. Should be called after initRendering.

Parameters
optionOption can be multiple (FEATURE_RENDERER | SURFACE_MESH_RENDERER)

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