MapLibre Native Core
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
mbgl::style::BackgroundLayer Class Referencefinal

#include <background_layer.hpp>

Inheritance diagram for mbgl::style::BackgroundLayer:

Public Member Functions

 BackgroundLayer (const std::string &layerID)
 
 ~BackgroundLayer () override
 
const PropertyValue< Color > & getBackgroundColor () const
 
void setBackgroundColor (const PropertyValue< Color > &)
 
void setBackgroundColorTransition (const TransitionOptions &)
 
TransitionOptions getBackgroundColorTransition () const
 
const PropertyValue< float > & getBackgroundOpacity () const
 
void setBackgroundOpacity (const PropertyValue< float > &)
 
void setBackgroundOpacityTransition (const TransitionOptions &)
 
TransitionOptions getBackgroundOpacityTransition () const
 
const PropertyValue< expression::Image > & getBackgroundPattern () const
 
void setBackgroundPattern (const PropertyValue< expression::Image > &)
 
void setBackgroundPatternTransition (const TransitionOptions &)
 
TransitionOptions getBackgroundPatternTransition () const
 
const Impl & impl () const
 
Mutable< Impl > mutableImpl () const
 
 BackgroundLayer (Immutable< Impl >)
 
std::unique_ptr< Layer > cloneRef (const std::string &id) const final
 

Static Public Member Functions

static PropertyValue< ColorgetDefaultBackgroundColor ()
 
static PropertyValue< float > getDefaultBackgroundOpacity ()
 
static PropertyValue< expression::ImagegetDefaultBackgroundPattern ()
 

Protected Member Functions

std::optional< conversion::ErrorsetPropertyInternal (const std::string &name, const conversion::Convertible &value) final
 
StyleProperty getProperty (const std::string &name) const final
 
Value serialize () const final
 
Mutable< Layer::Impl > mutableBaseImpl () const final
 

Detailed Description

Definition at line 17 of file background_layer.hpp.

Constructor & Destructor Documentation

◆ BackgroundLayer() [1/2]

mbgl::style::BackgroundLayer::BackgroundLayer ( const std::string &  layerID)

◆ ~BackgroundLayer()

mbgl::style::BackgroundLayer::~BackgroundLayer ( )
override

◆ BackgroundLayer() [2/2]

mbgl::style::BackgroundLayer::BackgroundLayer ( Immutable< Impl >  )

Member Function Documentation

◆ cloneRef()

std::unique_ptr<Layer> mbgl::style::BackgroundLayer::cloneRef ( const std::string &  id) const
final

◆ getBackgroundColor()

const PropertyValue<Color>& mbgl::style::BackgroundLayer::getBackgroundColor ( ) const

◆ getBackgroundColorTransition()

TransitionOptions mbgl::style::BackgroundLayer::getBackgroundColorTransition ( ) const

◆ getBackgroundOpacity()

const PropertyValue<float>& mbgl::style::BackgroundLayer::getBackgroundOpacity ( ) const

◆ getBackgroundOpacityTransition()

TransitionOptions mbgl::style::BackgroundLayer::getBackgroundOpacityTransition ( ) const

◆ getBackgroundPattern()

const PropertyValue<expression::Image>& mbgl::style::BackgroundLayer::getBackgroundPattern ( ) const

◆ getBackgroundPatternTransition()

TransitionOptions mbgl::style::BackgroundLayer::getBackgroundPatternTransition ( ) const

◆ getDefaultBackgroundColor()

static PropertyValue<Color> mbgl::style::BackgroundLayer::getDefaultBackgroundColor ( )
static

◆ getDefaultBackgroundOpacity()

static PropertyValue<float> mbgl::style::BackgroundLayer::getDefaultBackgroundOpacity ( )
static

◆ getDefaultBackgroundPattern()

static PropertyValue<expression::Image> mbgl::style::BackgroundLayer::getDefaultBackgroundPattern ( )
static

◆ getProperty()

StyleProperty mbgl::style::BackgroundLayer::getProperty ( const std::string &  name) const
finalprotected

◆ impl()

const Impl& mbgl::style::BackgroundLayer::impl ( ) const

◆ mutableBaseImpl()

Mutable<Layer::Impl> mbgl::style::BackgroundLayer::mutableBaseImpl ( ) const
finalprotected

◆ mutableImpl()

Mutable<Impl> mbgl::style::BackgroundLayer::mutableImpl ( ) const

◆ serialize()

Value mbgl::style::BackgroundLayer::serialize ( ) const
finalprotected

◆ setBackgroundColor()

void mbgl::style::BackgroundLayer::setBackgroundColor ( const PropertyValue< Color > &  )

◆ setBackgroundColorTransition()

void mbgl::style::BackgroundLayer::setBackgroundColorTransition ( const TransitionOptions )

◆ setBackgroundOpacity()

void mbgl::style::BackgroundLayer::setBackgroundOpacity ( const PropertyValue< float > &  )

◆ setBackgroundOpacityTransition()

void mbgl::style::BackgroundLayer::setBackgroundOpacityTransition ( const TransitionOptions )

◆ setBackgroundPattern()

void mbgl::style::BackgroundLayer::setBackgroundPattern ( const PropertyValue< expression::Image > &  )

◆ setBackgroundPatternTransition()

void mbgl::style::BackgroundLayer::setBackgroundPatternTransition ( const TransitionOptions )

◆ setPropertyInternal()

std::optional<conversion::Error> mbgl::style::BackgroundLayer::setPropertyInternal ( const std::string &  name,
const conversion::Convertible value 
)
finalprotected

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