GRE::LAYER_RASTER Class Reference

Raster Layer class. More...

#include <gre/lrraster.h>

Inheritance diagram for GRE::LAYER_RASTER:

Classes
class	COMMONPARM
class	DISPPARM
struct	SHADEPARM
	Shading parameters. More...
Public Types
enum	COLORBLEND { COLORBLEND_RGBI_HIS = 1, COLORBLEND_RGBI_HBS = 2, COLORBLEND_RGBI_Ratio = 3, COLORBLEND_RGBI_Brovey = 4, COLORBLEND_RGBI_LAST = 4 }
enum	SUBTYPE { SUBTYPE_Single = 0, SUBTYPE_Hyperspectral = 1, SUBTYPE_MultiCI = 2, SUBTYPE_MultiRGB = 3, SUBTYPE_MultiHIS = 4, SUBTYPE_MultiHBS = 5, SUBTYPE_MultiRGBI = 6, SUBTYPE_MultiCMY = 7, SUBTYPE_MultiCMYK = 8, SUBTYPE_External = 9 }
Public Member Functions
	LAYER_RASTER (GRE::GROUP group, CREATEFLAGS createflags=CREATEFLAG_None, GRE::LISTPOS listpos=GRE::LISTPOS_Last, LAYER reflayer=0)
virtual	~LAYER_RASTER ()
ERRVALUE	AssignObjects (SUBTYPE subtype, const RVC::OBJITEMLIST &objitems)
bool	CanDoShading () const
void	ClearPedestal ()
GRE::LEGEND_COLORSAMPLE &	GetColorSampleLegend ()
LAYER_RASTER::COMMONPARM *	GetCommonParm () const
const DISPPARM &	GetDispParm () const
int	PromptObjects (SUBTYPE subtype, bool OpenCtrlPanel=false, MDLGPARENT dlgparent=0)
int	SetColorMap (const COLOR_ARRAY &colmap, const RVC::OBJECTNAME &ColorPaletteName)
ERRVALUE	SetDispParm (const DISPPARM &dispparm)
ERRVALUE	SetMask (const RVC::OBJITEM &objitem)
void	SetMaskNone ()
ERRVALUE	SetupInitialPipelineStages (SPATMOD::IMAGE::STAGE_AUTOPTR &StagePtr, const SPATMOD::GEOREFERENCE *pGeoreference)
int	UpdateContrastFromRegion (const REGION2D &region)
int	UpdateContrastFullArea ()
Static Public Member Functions
static ERRVALUE	DlgGetObjects (MDLGPARENT dlgparent, UINT8 dispmode, RVC::OBJITEMLIST &ObjItemList)
static LAYER_RASTER::COMMONPARM *	GetCommonParm (GROUP *group)
static const SML::CLASSMEMBER *	GetSMLClassMembers ()
static void	RegisterType ()
static void	SMLClassInstall (SML::CONTEXT *context)
Protected Attributes
DISPPARM	m_dispparm

Detailed Description

Raster Layer class.

Member Enumeration Documentation

enum GRE::LAYER_RASTER::COLORBLEND

Enumerator:

COLORBLEND_RGBI_HIS
COLORBLEND_RGBI_HBS
COLORBLEND_RGBI_Ratio
COLORBLEND_RGBI_Brovey
COLORBLEND_RGBI_LAST

enum GRE::LAYER_RASTER::SUBTYPE

Enumerator:

SUBTYPE_Single
SUBTYPE_Hyperspectral
SUBTYPE_MultiCI
SUBTYPE_MultiRGB
SUBTYPE_MultiHIS
SUBTYPE_MultiHBS
SUBTYPE_MultiRGBI
SUBTYPE_MultiCMY
SUBTYPE_MultiCMYK
SUBTYPE_External

Constructor & Destructor Documentation

GRE::LAYER_RASTER::LAYER_RASTER	(	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_RASTER::~LAYER_RASTER ( ) [virtual]

Member Function Documentation

ERRVALUE GRE::LAYER_RASTER::AssignObjects	(	SUBTYPE	subtype,
		const RVC::OBJITEMLIST &	objitems
	)

Assign layer to use specified object(s).

Parameters:

	subtype	Raster layer subtype
	objitems	Object item list

bool GRE::LAYER_RASTER::CanDoShading ( ) const

void GRE::LAYER_RASTER::ClearPedestal ( )

static ERRVALUE GRE::LAYER_RASTER::DlgGetObjects	(	MDLGPARENT	dlgparent,
		UINT8	dispmode,
		RVC::OBJITEMLIST &	ObjItemList
	)			`[static]`

Parameters:

dispmode

RASTDISPMODE_...

GRE::LEGEND_COLORSAMPLE& GRE::LAYER_RASTER::GetColorSampleLegend ( ) [inline]

Retrieve color-sample legend.

LAYER_RASTER::COMMONPARM* GRE::LAYER_RASTER::GetCommonParm ( ) const [inline]

Get common parameters for all layers of this type in group.

static LAYER_RASTER::COMMONPARM* GRE::LAYER_RASTER::GetCommonParm ( GROUP * group ) [static]

Get common parameters for all layers of this type in group.

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

Retrieve layer-specific display parameters.

Returns:: current parameters

static const SML::CLASSMEMBER* GRE::LAYER_RASTER::GetSMLClassMembers ( ) [static]

Return the list of SML class members for this layer type.

Reimplemented from GRE::LAYER.

int GRE::LAYER_RASTER::PromptObjects	(	SUBTYPE	subtype,
		bool	OpenCtrlPanel = `false`,
		MDLGPARENT	dlgparent = `0`
	)

Prompt user to select object(s) for raster layer.

Parameters:

	subtype	Raster layer subtype
	OpenCtrlPanel	Whether or not to show control panel after selection
	dlgparent	Parent for dialogs

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

Register this layer type.

int GRE::LAYER_RASTER::SetColorMap	(	const COLOR_ARRAY &	colmap,
		const RVC::OBJECTNAME &	ColorPaletteName
	)

Set color palette to use.

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

Set layer-specific display parameters.

This is the recommended method for changing how an existing layer is to be rendered. Validation will be performed on the specified parameters and adjustments made to the layer's copy if necessary. Use of this method usually result 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

ERRVALUE GRE::LAYER_RASTER::SetMask ( const RVC::OBJITEM & objitem )

Set mask to use.

void GRE::LAYER_RASTER::SetMaskNone ( )

Set to not use mask.

ERRVALUE GRE::LAYER_RASTER::SetupInitialPipelineStages	(	SPATMOD::IMAGE::STAGE_AUTOPTR &	StagePtr,
		const SPATMOD::GEOREFERENCE *	pGeoreference
	)

Setup initial pipeline stages.

static void GRE::LAYER_RASTER::SMLClassInstall ( SML::CONTEXT * context ) [static]

Method to install SML class, called by internal SML function.

Parameters:

context

SML context

Reimplemented from GRE::LAYER.

int GRE::LAYER_RASTER::UpdateContrastFromRegion ( const REGION2D & region )

Update constrast to compute within specified region.

Parameters:

region

Region

int GRE::LAYER_RASTER::UpdateContrastFullArea ( )

Update constrast to use full area.

Member Data Documentation

DISPPARM GRE::LAYER_RASTER::m_dispparm [protected]

Layer-specific display parameters.

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

gre/lrraster.h

GRE::LAYER_RASTER Class Reference

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation