GeoGen API Reference
Classes | Enumerations | Functions
geogen::renderer Namespace Reference

Contains the renderer and all associated classes. More...

Classes

class  MemoryLimitException
 Exception thrown when the Renderer determines it can't execute a step because it would need to allocate amount of memory greater than Configuration::RendererMemoryLimit. More...
 
class  RenderedMap
 A single map produced by the Renderer. More...
 
class  RenderedMapTable
 A table used to temporarily store rendered maps. More...
 
class  Renderer
 Renders a single RenderingSequence into a set of height maps. More...
 
class  RendererException
 Base class for exceptions throw during map rendering. More...
 
class  RendererObject
 Represents an object managed by the renderer. Associates a type label with an instance of genlib::DataObject. More...
 
class  RendererObjectSlotTable
 A table used to assign addresses of any objects to RendererObjectTable slots. More...
 
class  RendererObjectTable
 A table of RendererObject items stored in a fixed number of slots. More...
 
class  RenderingBounds
 Contains rendering bounds for a RenderingStep. More...
 
class  RenderingBounds1D
 
class  RenderingBounds2D
 
class  RenderingGraph
 A graph of dependenies between RenderingStep objects. More...
 
class  RenderingGraphNode
 Single node in RenderingGraph. More...
 
class  RenderingSequence
 
class  RenderingSequenceMetadata
 
class  RenderingStep
 
class  RenderingStep1D
 
class  RenderingStep2D
 

Enumerations

enum  RendererStepResult { RENDERER_STEP_RESULT_RUNNING, RENDERER_STEP_RESULT_FINISHED }
 Results of a Renderer.Step call. More...
 
enum  RendererStatus { RENDERER_STATUS_READY, RENDERER_STATUS_FINISHED, RENDERER_STATUS_FAULTED }
 State of a Renderer. More...
 
enum  RendererObjectType { RENDERER_OBJECT_TYPE_HEIGHT_PROFILE, RENDERER_OBJECT_TYPE_HEIGHT_MAP }
 Supported types of RendererObject. More...
 
enum  RenderingStepType { RENDERING_STEP_TYPE_1D, RENDERING_STEP_TYPE_2D }
 

Functions

String RendererObjectTypeToString (RendererObjectType objectType)
 Converts a RendererObjectType to string. More...
 

Detailed Description

Contains the renderer and all associated classes.

Enumeration Type Documentation

Supported types of RendererObject.

Enumerator
RENDERER_OBJECT_TYPE_HEIGHT_PROFILE 

1-dimensional map (HeightProfile).

RENDERER_OBJECT_TYPE_HEIGHT_MAP 

2-dimensional map (HeightMap).

State of a Renderer.

Enumerator
RENDERER_STATUS_READY 

The renderer is ready to step.

RENDERER_STATUS_FINISHED 

The renderer is finished, no more steps are available.

RENDERER_STATUS_FAULTED 

The renderer has caused an error and can't continue.

Results of a Renderer.Step call.

Enumerator
RENDERER_STEP_RESULT_RUNNING 

The step was executed and next step is available and ready to be executed.

RENDERER_STEP_RESULT_FINISHED 

The step was executed, but it was the last and the Renderer can't continue.

Function Documentation

String geogen::renderer::RendererObjectTypeToString ( RendererObjectType  objectType)

Converts a RendererObjectType to string.

Parameters
objectTypeThe renderer object type.
Returns
The string name of the type.