Beatmup::Scene::Layer Class Reference

Abstract scene layer having name, type, geometry and some content to display. More...

#include <scene.h>

Inheritance diagram for Beatmup::Scene::Layer:

Public Types
enum class	Type {   SceneLayer = 0 , BitmapLayer , MaskedBitmapLayer , ShapedBitmapLayer ,   ShadedBitmapLayer }

Public Member Functions
Type	getType () const
const std::string &	getName () const
void	setName (const char *name)
AffineMapping &	getMapping ()
const AffineMapping &	getMapping () const
void	setMapping (const AffineMapping &mapping)
virtual bool	testPoint (float x, float y) const
	Tests if a given point falls in the layer. More...
virtual Layer *	getChild (float x, float y, unsigned int recursionDepth=0) const
	Picks a child layer at given point, if any. More...
bool	isVisible () const
	Returns layer visibility flag. More...
bool	isPhantom () const
	Returns true if the layer is ignored when searching a layer by point. More...
void	setVisible (bool visible)
	Sets layer visibility. More...
void	setPhantom (bool phantom)
	Makes/unmakes the layer "phantom". More...
template<class LayerType >
LayerType &	castTo () const
Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Protected Member Functions
	Layer (Type type)
virtual void	render (RenderingContext &context)

Protected Attributes
AffineMapping	mapping
	layer mapping More...
bool	visible
	layer visibility More...
bool	phantom
	if true, layer is ignored by selection by point More...

Private Member Functions
	Layer (const Layer &)=delete
	disabling copying constructor More...

Private Attributes
Type	type
std::string	name
	layer name More...

Friends
class	SceneRenderer

Detailed Description

Abstract scene layer having name, type, geometry and some content to display.

The layer geometry is defined by an AffineMapping describing the position and the orientation of the layer content in the rendered image.

Definition at line 64 of file scene.h.

Member Enumeration Documentation

Type

enum Beatmup::Scene::Layer::Type

strong

Enumerator
SceneLayer	layer containing a scene
BitmapLayer	layer displaying a bitmap
MaskedBitmapLayer	layer displaying a bitmap with mask
ShapedBitmapLayer	layer displaying a bitmap within a shape
ShadedBitmapLayer	layer displaying a bitmap through a custom fragment shader

Definition at line 68 of file scene.h.

                            {
                SceneLayer = 0,         //!< layer containing a scene
                BitmapLayer,            //!< layer displaying a bitmap
                MaskedBitmapLayer,      //!< layer displaying a bitmap with mask
                ShapedBitmapLayer,      //!< layer displaying a bitmap within a shape
                ShadedBitmapLayer       //!< layer displaying a bitmap through a custom fragment shader
            };

Constructor & Destructor Documentation

Layer() [1/2]

Beatmup::Scene::Layer::Layer ( const Layer &  )

privatedelete

disabling copying constructor

Layer() [2/2]

Scene::Layer::Layer ( Type  type )

protected

Definition at line 238 of file scene.cpp.

: visible(true), phantom(false), type(type) {}

Member Function Documentation

render()

virtual void Beatmup::Scene::Layer::render ( RenderingContext &  context )

inlineprotectedvirtual

Reimplemented in Beatmup::Scene::ShadedBitmapLayer, Beatmup::Scene::ShapedBitmapLayer, Beatmup::Scene::MaskedBitmapLayer, and Beatmup::Scene::BitmapLayer.

Definition at line 78 of file scene.h.

{}

getType()

Type Beatmup::Scene::Layer::getType ( ) const

inline

Returns

type of the current layer.

Definition at line 92 of file scene.h.

{ return type; }

getName()

const std::string& Beatmup::Scene::Layer::getName ( ) const

inline

Definition at line 94 of file scene.h.

{ return name; }

setName()

void Beatmup::Scene::Layer::setName ( const char *  name )

inline

Definition at line 95 of file scene.h.

{ this->name = name; }

getMapping() [1/2]

AffineMapping& Beatmup::Scene::Layer::getMapping ( )

inline

Definition at line 97 of file scene.h.

{ return mapping; }

getMapping() [2/2]

const AffineMapping& Beatmup::Scene::Layer::getMapping ( ) const

inline

Definition at line 98 of file scene.h.

{ return mapping; }

setMapping()

void Beatmup::Scene::Layer::setMapping ( const AffineMapping &  mapping )

inline

Definition at line 99 of file scene.h.

{ this->mapping = mapping; }

testPoint()

bool Scene::Layer::testPoint ( float  x, float  y  ) const

virtual

Tests if a given point falls in the layer.

Reimplemented in Beatmup::Scene::ShapedBitmapLayer, Beatmup::Scene::MaskedBitmapLayer, Beatmup::Scene::BitmapLayer, and Beatmup::Scene::SceneLayer.

Definition at line 240 of file scene.cpp.

                                                 {
    return mapping.isPointInside(Point(x, y));
}

getChild()

Scene::Layer * Scene::Layer::getChild ( float  x, float  y, unsigned int  recursionDepth = 0  ) const

virtual

Picks a child layer at given point, if any.

Reimplemented in Beatmup::Scene::SceneLayer.

Definition at line 244 of file scene.cpp.

                                                                 {
    return nullptr;
}

isVisible()

bool Beatmup::Scene::Layer::isVisible ( ) const

inline

Returns layer visibility flag.

Definition at line 114 of file scene.h.

{ return visible; }

isPhantom()

bool Beatmup::Scene::Layer::isPhantom ( ) const

inline

Returns true if the layer is ignored when searching a layer by point.

Definition at line 119 of file scene.h.

{ return phantom; }

setVisible()

void Beatmup::Scene::Layer::setVisible ( bool  visible )

inline

Sets layer visibility.

Definition at line 124 of file scene.h.

{ this->visible = visible; }

setPhantom()

void Beatmup::Scene::Layer::setPhantom ( bool  phantom )

inline

Makes/unmakes the layer "phantom".

Phantom layers are rendered as usual but not picked when searching a layer by point.

Definition at line 130 of file scene.h.

{   this->phantom = phantom; }

castTo()

template<class LayerType >

LayerType& Beatmup::Scene::Layer::castTo ( ) const

inline

Definition at line 132 of file scene.h.

                                                                {
                return (LayerType&)(*this);
            }

Friends And Related Function Documentation

SceneRenderer

friend class SceneRenderer

friend

Definition at line 65 of file scene.h.

Member Data Documentation

mapping

AffineMapping Beatmup::Scene::Layer::mapping

protected

layer mapping

Definition at line 80 of file scene.h.

visible

bool Beatmup::Scene::Layer::visible

protected

layer visibility

Definition at line 81 of file scene.h.

phantom

bool Beatmup::Scene::Layer::phantom

protected

if true, layer is ignored by selection by point

Definition at line 82 of file scene.h.

type

Type Beatmup::Scene::Layer::type

private

Definition at line 85 of file scene.h.

name

std::string Beatmup::Scene::Layer::name

private

layer name

Definition at line 86 of file scene.h.

---

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

• core/scene/scene.h
• core/scene/scene.cpp