GRE::LAYERSECTION Class Reference

Container for layer information retained for a section of layer. More...

#include <gre/layersection.h>

Inheritance diagram for GRE::LAYERSECTION:

Public Member Functions
	LAYERSECTION (GRE::LAYER layer, GRE::VIEW view)
void	ClearLabelPlacement ()
void	CloseZView ()
void	ComputeClipRegion (REGION2D &ClipRegion)
UNSIGNEDSET *	GetElemDrawnSet (ELEMTYPE ElemType, bool UseHighlighted)
const UNSIGNEDSET *	GetElemDrawnSet (ELEMTYPE ElemType, bool UseHighlighted) const
LABELPLACEMENT *	GetLabelPlacement (bool ReturnNullIfEmpty=true)
GRE::LAYER *	GetLayer () const
RENDERBUFFER &	GetRenderBuffer (GRE::RENDERTARGET content)
const RENDERBUFFER &	GetRenderBuffer (GRE::RENDERTARGET content) const
const TRANS2D_MAPGEN &	GetTransLayerBuffer () const
GRE::VIEW *	GetView () const
const ZVIEW *	GetZView (bool DoSetup=true)
bool	HasRendered (GRE::RENDERTARGET content) const
bool	OverlayBufferIfRendered (GRE::RENDERTARGET content, MGD::DEVICE pDevTarget, const LRECT2D pClipRect=0) const
ERRVALUE	QueueJobRender (MITHREAD::QUEUE &Queue)
void	Release ()
void	ResetAllDrawnSets ()
void	ResetRendered (GRE::RENDERTARGET content=GRE::RENDERTARGET_LayerAll)
void	SetTransLayerBuffer (const TRANS2D_MAPGEN &TransLayerBuffer)
ERRVALUE	SetupRenderBuffer (RENDERBUFFER &RenderBuffer, bool EraseExisting=false) const
Protected Member Functions
virtual	~LAYERSECTION ()
Private Member Functions
virtual UNSIGNEDSET *	v_GetElemDrawnSet (ELEMTYPE ElemType, bool UseHighlighted)
virtual LABELPLACEMENT *	v_GetLabelPlacement ()
virtual ZVIEW *	v_GetZView (bool DoSetup)

Detailed Description

Container for layer information retained for a section of layer.

Constructor & Destructor Documentation

GRE::LAYERSECTION::LAYERSECTION	(	GRE::LAYER *	layer,
		GRE::VIEW *	view
	)			`[explicit]`

Constructor.

virtual GRE::LAYERSECTION::~LAYERSECTION ( ) [protected, virtual]

Member Function Documentation

void GRE::LAYERSECTION::ClearLabelPlacement ( )

Clear label placement if any.

void GRE::LAYERSECTION::CloseZView ( )

Close Z view surface objects if any.

void GRE::LAYERSECTION::ComputeClipRegion ( REGION2D & ClipRegion )

Compute clip region in buffer device coordinates.

Parameters:

ClipRegion

Clipping region returned

UNSIGNEDSET* GRE::LAYERSECTION::GetElemDrawnSet	(	ELEMTYPE	ElemType,
		bool	UseHighlighted
	)			`[inline]`

Get set for elements drawn in view (non-const).

Returns:: NULL if no elements of specified type supported by layer. The set returned by this method should only contain the elements which are actually visible in the view. Normally when checking for highlighted elements, the GRE::LAYER::GetElemHighlightSet method should be used.

Parameters:

UseHighlighted

Element type True to return set for visible elements drawn as 'highlighted'

const UNSIGNEDSET* GRE::LAYERSECTION::GetElemDrawnSet	(	ELEMTYPE	ElemType,
		bool	UseHighlighted
	)			const `[inline]`

Get set for elements drawn in view (const).

Returns:: NULL if no elements of specified type supported by layer. The set returned by this method only contains the elements which are actually visible in the view. Normally when checking for highlighted elements, the GRE::LAYER::GetElemHighlightSet method should be used.

Parameters:

UseHighlighted

Element type True to return set for visible elements drawn as 'highlighted'

LABELPLACEMENT* GRE::LAYERSECTION::GetLabelPlacement ( bool ReturnNullIfEmpty = true )

Get pointer to label placement instance.

Returns:: LABELPLACEMENT pointer or NULL if not supported.

Parameters:

ReturnNullIfEmpty

Return NULL pointer if no labels

GRE::LAYER* GRE::LAYERSECTION::GetLayer ( ) const [inline]

Get associated GRE::LAYER.

RENDERBUFFER& GRE::LAYERSECTION::GetRenderBuffer ( GRE::RENDERTARGET content )

Get rendering buffer for specified rendering target (non-const).

Parameters:

content

Rendering content

const RENDERBUFFER& GRE::LAYERSECTION::GetRenderBuffer ( GRE::RENDERTARGET content ) const

Get rendering buffer for specified rendering target (const).

Parameters:

content

Rendering content

const TRANS2D_MAPGEN& GRE::LAYERSECTION::GetTransLayerBuffer ( ) const [inline]

Get transformation from layer to buffer.

GRE::VIEW* GRE::LAYERSECTION::GetView ( ) const [inline]

Get assigned view.

const ZVIEW* GRE::LAYERSECTION::GetZView ( bool DoSetup = true ) [inline]

Get ZVIEW for surface value access and stereo drawing.

Returns:: Pointer to ZVIEW if available, NULL if not.

bool GRE::LAYERSECTION::HasRendered ( GRE::RENDERTARGET content ) const

Determine if has rendered all of specified content types.

Parameters:

content

Rendering content

bool GRE::LAYERSECTION::OverlayBufferIfRendered	(	GRE::RENDERTARGET	content,
		MGD::DEVICE *	pDevTarget,
		const LRECT2D *	pClipRect = `0`
	)			const

Overlay rendering buffer on device if it has been rendered.

Returns:: true if did overlay, false if not.

Parameters:

	content	Rendering content
	pDevTarget	Target device
	pClipRect	Optional clip rectangle

ERRVALUE GRE::LAYERSECTION::QueueJobRender ( MITHREAD::QUEUE & Queue )

Create and queue job for rendering section.

Parameters:

Queue

Queue to place job in

void GRE::LAYERSECTION::Release ( )

Safely release and destroy class instance, supporting multithreading.

void GRE::LAYERSECTION::ResetAllDrawnSets ( )

Reset all 'drawn element' sets to have no entries.

void GRE::LAYERSECTION::ResetRendered ( GRE::RENDERTARGET content = GRE::RENDERTARGET_LayerAll )

Reset rendered status so redraws.

void GRE::LAYERSECTION::SetTransLayerBuffer ( const TRANS2D_MAPGEN & TransLayerBuffer ) [inline]

Set transformation from layer (object) to buffer (device).

ERRVALUE GRE::LAYERSECTION::SetupRenderBuffer	(	RENDERBUFFER &	RenderBuffer,
		bool	EraseExisting = `false`
	)			const

Setup render buffer.

virtual UNSIGNEDSET* GRE::LAYERSECTION::v_GetElemDrawnSet	(	ELEMTYPE	ElemType,
		bool	UseHighlighted
	)			`[private, virtual]`

Get set for elements drawn in view.

Returns:: NULL if no elements of specified type supported by layer.

virtual LABELPLACEMENT* GRE::LAYERSECTION::v_GetLabelPlacement ( ) [private, virtual]

Get pointer label placement manager.

Returns:: NULL if labels not supported.

virtual ZVIEW* GRE::LAYERSECTION::v_GetZView ( bool DoSetup ) [private, virtual]

Get ZVIEW for surface value access and stereo drawing.

Default implementation returns NULL.

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

gre/layersection.h

GRE::LAYERSECTION Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation