GRE::LAYER_SURFACE Class Reference

Surface layer, used to drape other layers for 3D / stereo. More...

#include <gre/lrsurface.h>

Inheritance diagram for GRE::LAYER_SURFACE:

Classes
class	DISPPARM
Public Types
enum	RENDERING_MODE { RENDERING_MODE_None = -1, RENDERING_MODE_VariableTriangulation = 0, RENDERING_MODE_PiecewiseTIN = 1, RENDERING_MODE_FlatTriangulation = 2 }
Public Member Functions
	LAYER_SURFACE (GRE::GROUP group, CREATEFLAGS createflags=CREATEFLAG_None, GRE::LISTPOS listpos=GRE::LISTPOS_Last, LAYER reflayer=0)
virtual	~LAYER_SURFACE ()
bool	CanReadValues () const
const DISPPARM &	GetDispParm () const
SPATMOD::IMAGE::STAGE *	GetImageStageTerrain () const
ERRVALUE	GetPointsZ (const TRANS2D_MAPGEN &PointToSurface, POLYLINE &PolyLine, double dftz)
int	GetPointsZ (const TRANS2D_MAPGEN &PointToSurface, DPOINT3D *points, INT32 NumPoints, double dftz)
ERRVALUE	GetPointsZBilinear (const TRANS2D_MAPGEN &PointToSurface, POLYLINE &PolyLine, double dftz)
int	GetPointZ (const DPOINT2D &spoint, double &z, bool DoSearch)
int	GetPointZInterpolated (const DPOINT2D &spoint, double &z)
GRE::TERRAIN *	GetTerrain ()
ERRVALUE	Read (INT32 row, INT32 col, INT32 ncols, double buffer, UINT8 mask)
ERRVALUE	SetDispParm (const DISPPARM &dispparm)
Static Public Member Functions
static ERRVALUE	CreateDefault (MDLGPARENT dlgparent, GROUP group, LAYER_SURFACE *pLayer=0)
static ERRVALUE	CreateDefaultFromOnline (GROUP group, LAYER_SURFACE *pLayer=0)
static ERRVALUE	DlgGetObject (MDLGPARENT dlgparent, RVC::OBJITEM &ObjItem)
static void	RegisterType ()
Protected Attributes
DISPPARM	m_dispparm

Detailed Description

Surface layer, used to drape other layers for 3D / stereo.

Member Enumeration Documentation

enum GRE::LAYER_SURFACE::RENDERING_MODE

Enumerator:

RENDERING_MODE_None
RENDERING_MODE_VariableTriangulation
RENDERING_MODE_PiecewiseTIN
RENDERING_MODE_FlatTriangulation

Constructor & Destructor Documentation

GRE::LAYER_SURFACE::LAYER_SURFACE	(	GRE::GROUP *	group,
		CREATEFLAGS	createflags = `CREATEFLAG_None`,
		GRE::LISTPOS	listpos = `GRE::LISTPOS_Last`,
		LAYER *	reflayer = `0`
	)			`[explicit]`

Construct layer and insert into list.

Parameters:

	group	Group to contain layer
	createflags	Creation flags
	listpos	Position in list
	reflayer	Reference layer for insertion

virtual GRE::LAYER_SURFACE::~LAYER_SURFACE ( ) [virtual]

Member Function Documentation

bool GRE::LAYER_SURFACE::CanReadValues ( ) const [inline]

Determine if can read surface values directly.

Use to determine if can call any of the GetPoint/sZ or Read methods.

static ERRVALUE GRE::LAYER_SURFACE::CreateDefault	(	MDLGPARENT	dlgparent,
		GROUP *	group,
		LAYER_SURFACE **	pLayer = `0`
	)			`[static]`

Create default surface layer, prompting user or using from online terrain.

Parameters:

	dlgparent	Parent for dialog when prompt user
	group	Group
	pLayer	Returned pointer to layer created if needed

static ERRVALUE GRE::LAYER_SURFACE::CreateDefaultFromOnline	(	GROUP *	group,
		LAYER_SURFACE **	pLayer = `0`
	)			`[static]`

Create default surface layer from online terrain.

Parameters:

	group	Group
	pLayer	Returned pointer to layer created if needed

static ERRVALUE GRE::LAYER_SURFACE::DlgGetObject	(	MDLGPARENT	dlgparent,
		RVC::OBJITEM &	ObjItem
	)			`[static]`

Prompt user to select object for terrain layer.

Parameters:

	dlgparent	Parent for dialog when prompt user
	ObjItem	Object location returned

const DISPPARM& GRE::LAYER_SURFACE::GetDispParm ( ) const [inline]

Retrieve layer-specific display parameters.

SPATMOD::IMAGE::STAGE* GRE::LAYER_SURFACE::GetImageStageTerrain ( ) const [inline]

Return pointer to image stage for terrain.

Do not delete, or assign ownership for, the returned pointer.

ERRVALUE GRE::LAYER_SURFACE::GetPointsZ	(	const TRANS2D_MAPGEN &	PointToSurface,
		POLYLINE &	PolyLine,
		double	dftz
	)

Get Z coordinates for set of points.

This method is used mainly in 3D rendering and measurement to obtain the Z coordinates of one or more points in some other map projection or layer coordinate system.

Parameters:

	PointToSurface	Transformation from point to surface object coordinates
	PolyLine	Points to obtain Z values for
	dftz	Default Z value for off-surface points

int GRE::LAYER_SURFACE::GetPointsZ	(	const TRANS2D_MAPGEN &	PointToSurface,
		DPOINT3D *	points,
		INT32	NumPoints,
		double	dftz
	)

Get Z coordinates for set of points.

This method is used mainly in 3D rendering and measurement to obtain the Z coordinates of one or more points in some other map projection or layer coordinate system.

Parameters:

	PointToSurface	Transformation from point to surface object coordinates
	points	Points to obtain Z values for
	NumPoints	Number of points
	dftz	Default Z value for off-surface points

ERRVALUE GRE::LAYER_SURFACE::GetPointsZBilinear	(	const TRANS2D_MAPGEN &	PointToSurface,
		POLYLINE &	PolyLine,
		double	dftz
	)

Get Z coordinates for set of points with Bilinear interpolation.

This method is used mainly in 3D editing to obtain the Z coordinates of one or more points in some other layer coordinate reference system.

Parameters:

	PointToSurface	Transformation from point to surface object coordinates
	PolyLine	Points to obtain Z values for
	dftz	Default Z value for off-surface points

int GRE::LAYER_SURFACE::GetPointZ	(	const DPOINT2D &	spoint,
		double &	z,
		bool	DoSearch
	)

Get Z value for single point.

Returns:: TRUE if valid, FALSE if not, < 0 if error

Parameters:

	spoint	Point in surface object coordinates
	z	Z value returned if return value indicates valid, unchanged if not
	DoSearch	Do hueristic neighborhood search if point just off edge or on null cell

int GRE::LAYER_SURFACE::GetPointZInterpolated	(	const DPOINT2D &	spoint,
		double &	z
	)

Get Z value for single point.

Returns:: TRUE if valid, FALSE if not, < 0 if error

Parameters:

	spoint	Point in surface object coordinates
	z	Z value returned if return value indicates valid, unchanged if not

GRE::TERRAIN* GRE::LAYER_SURFACE::GetTerrain ( ) [inline]

ERRVALUE GRE::LAYER_SURFACE::Read	(	INT32	row,
		INT32	col,
		INT32	ncols,
		double *	buffer,
		UINT8 *	mask
	)

Read from surface raster.

Parameters:

	row	Initial row
	col	Initial column
	ncols	Number of columns
	buffer	Buffer for result
	mask	Buffer for mask, 0 if don't need

static void GRE::LAYER_SURFACE::RegisterType ( ) [static]

Register this layer type.

ERRVALUE GRE::LAYER_SURFACE::SetDispParm ( const DISPPARM & dispparm )

Set layer-specific display parameters.

Validation will be performed on the specified parameters and adjustments made to the layer's copy if necessary. Use of this method usually results in a ChangeBegin / ChangeEnd message pair, and will also generate a ChangeObject message if the spatial object used in the layer is changed.

Parameters:

dispparm

Parameters to set