LuciadCPillar 2023.1.06
luciad::GridLayer Class Referenceabstract

Common representation for grid layers that can be added to a map. More...

#include <luciad/layers/grids/GridLayer.h>

Inheritance diagram for luciad::GridLayer:
luciad::Layer luciad::LonLatGridLayer luciad::MgrsGridLayer

Public Member Functions

virtual bool isLabeled () const =0
 Returns whether this layer displays labels. More...
 
virtual void setLabeled (bool labeled)=0
 Sets whether this layer displays labels. More...
 
- Public Member Functions inherited from luciad::Layer
 Layer ()
 Default constructor. More...
 
virtual ~Layer ()=default
 
virtual void addObserver (std::shared_ptr< ILayerObserver > layerObserver)=0
 Adds an observer that allows to receive change events from this layer. More...
 
virtual LayerId getId () const
 Returns the layer's unique id. More...
 
virtual const std::string & getTitle () const =0
 Returns the layer's title. More...
 
virtual bool isVisible () const =0
 Returns whether this layer is visible. More...
 
virtual void removeObserver (const std::shared_ptr< ILayerObserver > &layerObserver)=0
 Removes the given observer. More...
 
virtual void setTitle (std::string title)=0
 Sets the layer's title. More...
 
virtual void setVisible (bool visible)=0
 Sets whether this layer is visible. More...
 

Static Public Member Functions

static const std::string & propertyLabeled ()
 Property name for the LayerEvent that is fired as a result of changing the layer's labeled flag. More...
 
- Static Public Member Functions inherited from luciad::Layer
static const std::string & propertyTitle ()
 Property name for the LayerEvent that is fired as a result of changing the layer's title. More...
 
static const std::string & propertyVisible ()
 Property name for the LayerEvent that is fired as a result of changing the layer's visible flag. More...
 

Protected Member Functions

 GridLayer ()
 Default constructor. More...
 

Detailed Description

Common representation for grid layers that can be added to a map.

You need a concrete grid layer extension.

Since
2023.1

Constructor & Destructor Documentation

◆ GridLayer()

luciad::GridLayer::GridLayer ( )
protected

Default constructor.

It's not the intent to extend from this class, nor is it the intent to directly instantiate this class, so this constructor must not be used.

Member Function Documentation

◆ isLabeled()

virtual bool luciad::GridLayer::isLabeled ( ) const
pure virtual

Returns whether this layer displays labels.

Returns
whether this layer displays labels.

Implemented in luciad::LonLatGridLayer, and luciad::MgrsGridLayer.

◆ propertyLabeled()

static const std::string & luciad::GridLayer::propertyLabeled ( )
static

Property name for the LayerEvent that is fired as a result of changing the layer's labeled flag.

See also
setLabeled

◆ setLabeled()

virtual void luciad::GridLayer::setLabeled ( bool  labeled)
pure virtual

Sets whether this layer displays labels.

Parameters
labeledtrue to enable labels.

Implemented in luciad::LonLatGridLayer, and luciad::MgrsGridLayer.