GRE_LAYER_RASTER Class Reference

Raster Layer class. More...

#include <gre/lrraster.h>

Inheritance diagram for GRE_LAYER_RASTER:

[legend]List of all members.

Public Types
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
ERRVALUE	AssignObjects (SUBTYPE subtype, const RVC::OBJITEMLIST &objitems)
bool	CanDoShading () const
void	ClearPedestal ()
GRE_LEGEND_COLORSAMPLE &	GetColorSampleLegend ()
const DISPPARM &	GetDispParm () const
	GRE_LAYER_RASTER (GRE_GROUP *group, CREATEFLAGS createflags=CREATEFLAG_None, GRE::LISTPOS listpos=GRE::LISTPOS_Last, GRE_LAYER *reflayer=0)
virtual int	OpenObject (UINT32 filemode=RVCFILE_ReadLock, MDLGPARENT dlgparent=0)
int	PromptObjects (SUBTYPE subtype, bool OpenCtrlPanel=false, MDLGPARENT dlgparent=0)
int	SetColorMap (const SIMPLE_ARRAY< COLOR > &colmap, const RVC::OBJECTNAME &ColorPaletteName)
ERRVALUE	SetDispParm (const DISPPARM &dispparm)
ERRVALUE	SetMask (const RVC::OBJITEM &objitem)
void	SetObjRegion (const REGION2D &ObjRegion)
void	SetShadeAngles (double AzimAngle, double ElevAngle)
void	SetVisibleExtents (const LRECT2D &rect)
int	UpdateContrastFromRegion (const REGION2D &region)
virtual	~GRE_LAYER_RASTER ()
Static Public Member Functions
void	RegisterType ()
void	SMLClassInstall (SMLCONTEXT *context)
Protected Attributes
DISPPARM	m_dispparm

---

Detailed Description

Raster Layer class.

Definition at line 95 of file lrraster.h.

---

Member Enumeration Documentation

enum GRE_LAYER_RASTER::SUBTYPE

Enumeration values: SUBTYPE_Single  SUBTYPE_Hyperspectral  SUBTYPE_MultiCI  SUBTYPE_MultiRGB  SUBTYPE_MultiHIS  SUBTYPE_MultiHBS  SUBTYPE_MultiRGBI  SUBTYPE_MultiCMY  SUBTYPE_MultiCMYK  SUBTYPE_External  Definition at line 98 of file lrraster.h.

---

Constructor & Destructor Documentation

GRE_LAYER_RASTER::GRE_LAYER_RASTER (  GRE_GROUP *  group, CREATEFLAGS  createflags = CREATEFLAG_None, GRE::LISTPOS  listpos = GRE::LISTPOS_Last, GRE_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::~GRE_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 (   )  [inline]

Definition at line 485 of file lrraster.h.

GRE_LEGEND_COLORSAMPLE& GRE_LAYER_RASTER::GetColorSampleLegend (   )  [inline]

Retrieve color-sample legend. Definition at line 428 of file lrraster.h.

const DISPPARM& GRE_LAYER_RASTER::GetDispParm (   )  const [inline]

Retrieve layer-specific display parameters. Returns: current parameters Definition at line 422 of file lrraster.h.

virtual int GRE_LAYER_RASTER::OpenObject (  UINT32  filemode = RVCFILE_ReadLock, MDLGPARENT  dlgparent = 0 )  [virtual]

Open object(s) for this layer. Returns: TRUE if was opened, FALSE if open already, < 0 if error Parameters: filemode  RVC file access mode dlgparent  Parent for dialog 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

void GRE_LAYER_RASTER::RegisterType (   )  [static]

Register this layer type.

int GRE_LAYER_RASTER::SetColorMap (  const SIMPLE_ARRAY< COLOR > &  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::SetObjRegion (  const REGION2D &  ObjRegion  )  [inline]

Definition at line 465 of file lrraster.h.

void GRE_LAYER_RASTER::SetShadeAngles (  double  AzimAngle, double  ElevAngle )

Set azimuth and elevation angles for relief shading. Parameters: AzimAngle  Azimuth angle in RADIANS -PI to PI ElevAngle  Elevation angle in RADIANS 0 to PI/2

void GRE_LAYER_RASTER::SetVisibleExtents (  const LRECT2D &  rect  )

Set portion of raster to draw. Parameters: rect  Extents in columns/lines

void GRE_LAYER_RASTER::SMLClassInstall (  SMLCONTEXT *  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

---

Member Data Documentation

DISPPARM GRE_LAYER_RASTER::m_dispparm [protected]

Layer-specific display parameters. Definition at line 490 of file lrraster.h.

---

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

• gre/lrraster.h

---