An ordered set of layers representing a renderable content. More...

#include <scene.h>

Inheritance diagram for Beatmup::Scene:

Classes
class	BitmapLayer
	Layer having an image to render. More...

class	CustomMaskedBitmapLayer
	Layer containing a bitmap and a mask applied to the bitmap when rendering. More...

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

class	MaskedBitmapLayer
	Bitmap layer using another bitmap as a mask. More...

class	SceneIntegrityError

class	SceneLayer
	Layer containing an entire scene. More...

class	ShadedBitmapLayer
	Bitmap layer using a custom shader. More...

class	ShapedBitmapLayer
	Layer containing a bitmap and a parametric mask (shape) More...

Public Member Functions
	Scene ()

	~Scene ()

BitmapLayer &	newBitmapLayer (const char *name)

BitmapLayer &	newBitmapLayer ()

MaskedBitmapLayer &	newMaskedBitmapLayer (const char *name)

MaskedBitmapLayer &	newMaskedBitmapLayer ()

ShapedBitmapLayer &	newShapedBitmapLayer (const char *name)

ShapedBitmapLayer &	newShapedBitmapLayer ()

ShadedBitmapLayer &	newShadedBitmapLayer (const char *name)

ShadedBitmapLayer &	newShadedBitmapLayer ()

SceneLayer &	addScene (const Scene &scene)
	Adds a subscene to the current scene. More...

Layer *	getLayer (const char *name) const
	Retrieves a layer by its name or null if not found. More...

Layer &	getLayer (int index) const
	Retrieves a layer by its index. More...

Layer *	getLayer (float x, float y, unsigned int recursionDepth=0) const
	Retrieves a layer present at a specific point of the scene or null if not found. More...

int	getLayerIndex (const Layer &layer) const
	Returns layer index in the scene or -1 if not found. More...

int	getLayerCount () const
	Returns total number of layers in the scene. More...

bool	resolveMapping (const Layer &layer, AffineMapping &mapping) const
	Computes absolute mapping of a given layer with respect to the scene mapping. More...

void	attachLayer (Layer &layer)
	Attaches an existing layer to the scene. More...

Layer *	detachLayer (int index)
	Detaches a layer from the scene. More...

Public Member Functions inherited from Beatmup::LockableObject
void	lock ()

void	unlock ()

Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Private Member Functions
template<class Type >
Type &	newLayer (const char *name)

Private Attributes
std::vector< Layer * >	layers
	scene layers More...

Detailed Description

An ordered set of layers representing a renderable content.

Definition at line 37 of file scene.h.

Constructor & Destructor Documentation

◆ Scene()

Scene::Scene ( )

Definition at line 106 of file scene.cpp.

106 {}

◆ ~Scene()

Scene::~Scene ( )

Definition at line 109 of file scene.cpp.

               {
     for (auto it : layers)
         delete it;
 }

Member Function Documentation

◆ newLayer()

template<class Type >

Type& Beatmup::Scene::newLayer ( const char * name )

inlineprivate

Definition at line 43 of file scene.h.

                                                               {
             Type* l = new Type();
             l->setName(name);
             layers.push_back(l);
             return *l;
         }

◆ newBitmapLayer() [1/2]

Scene::BitmapLayer & Scene::newBitmapLayer ( const char * name )

Definition at line 115 of file scene.cpp.

                                                         {
     return newLayer<BitmapLayer>(name);
 }

◆ newBitmapLayer() [2/2]

Scene::BitmapLayer & Scene::newBitmapLayer ( )

Definition at line 120 of file scene.cpp.

                                         {
     return newLayer<BitmapLayer>(generateUniqueLayerName(*this, "Bitmap layer").c_str());
 }

◆ newMaskedBitmapLayer() [1/2]

Scene::MaskedBitmapLayer & Scene::newMaskedBitmapLayer ( const char * name )

Definition at line 125 of file scene.cpp.

                                                                     {
     return newLayer<MaskedBitmapLayer>(name);
 }

◆ newMaskedBitmapLayer() [2/2]

Scene::MaskedBitmapLayer & Scene::newMaskedBitmapLayer ( )

Definition at line 130 of file scene.cpp.

                                                     {
     return newLayer<MaskedBitmapLayer>(generateUniqueLayerName(*this, "Masked bitmap layer").c_str());
 }

◆ newShapedBitmapLayer() [1/2]

Scene::ShapedBitmapLayer & Scene::newShapedBitmapLayer ( const char * name )

Definition at line 135 of file scene.cpp.

                                                                     {
     return newLayer<ShapedBitmapLayer>(name);
 }

◆ newShapedBitmapLayer() [2/2]

Scene::ShapedBitmapLayer & Scene::newShapedBitmapLayer ( )

Definition at line 140 of file scene.cpp.

                                                     {
     return newLayer<ShapedBitmapLayer>(generateUniqueLayerName(*this, "Shaped bitmap layer").c_str());
 }

◆ newShadedBitmapLayer() [1/2]

Scene::ShadedBitmapLayer & Scene::newShadedBitmapLayer ( const char * name )

Definition at line 145 of file scene.cpp.

                                                                     {
     return newLayer<ShadedBitmapLayer>(name);
 }

◆ newShadedBitmapLayer() [2/2]

Scene::ShadedBitmapLayer & Scene::newShadedBitmapLayer ( )

Definition at line 150 of file scene.cpp.

                                                     {
     return newLayer<ShadedBitmapLayer>(generateUniqueLayerName(*this, "Shaped bitmap layer").c_str());
 }

◆ addScene()

Scene::SceneLayer & Scene::addScene ( const Scene & scene )

Adds a subscene to the current scene.

Definition at line 155 of file scene.cpp.

                                                    {
     SceneLayer* l = new SceneLayer(scene);
     l->setName(generateUniqueLayerName(*this, "Scene layer").c_str());
     layers.push_back(l);
     return *l;
 }

◆ getLayer() [1/3]

Scene::Layer * Scene::getLayer ( const char * name ) const

Retrieves a layer by its name or null if not found.

Definition at line 163 of file scene.cpp.

                                                   {
     for (auto l : layers)
         if (l->getName() == name)
             return l;
     return nullptr;
 }

◆ getLayer() [2/3]

Scene::Layer & Scene::getLayer ( int index ) const

Retrieves a layer by its index.

Definition at line 171 of file scene.cpp.

                                            {
     return *layers[index];
 }

◆ getLayer() [3/3]

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

Retrieves a layer present at a specific point of the scene or null if not found.

Definition at line 175 of file scene.cpp.

                                                                                {
     for (auto it = layers.crbegin(); it != layers.crend(); it++)
         if (!(*it)->isPhantom()) {
             if ((*it)->getType() == Scene::Layer::Type::SceneLayer) {
                 Layer *result = (*it)->getChild(x, y, recursionDepth + 1);
                 if (result)
                     return result;
             } else {
                 if ((*it)->testPoint(x, y))
                     return *it;
             }
         }
     return nullptr;
 }

◆ getLayerIndex()

int Scene::getLayerIndex ( const Layer & layer ) const

Returns layer index in the scene or -1 if not found.

Definition at line 191 of file scene.cpp.

                                                  {
     for (size_t i = 0; i < layers.size(); ++i)
         if (layers[i] == &layer)
             return (int)i;
     return -1;
 }

◆ getLayerCount()

int Scene::getLayerCount ( ) const

Returns total number of layers in the scene.

Definition at line 199 of file scene.cpp.

                                {
     return (int)layers.size();
 }

◆ resolveMapping()

bool Scene::resolveMapping	(	const Layer &	layer,
		AffineMapping &	mapping
	)		const

Computes absolute mapping of a given layer with respect to the scene mapping.

Returns: true if the given layer is reached, false otherwise (mapping is not changed in this case)

Definition at line 204 of file scene.cpp.

                                                                            {
     for (auto it = layers.crbegin(); it != layers.crend(); it++) {
         if (&layer == *it) {
             mapping = layer.getMapping();
             return true;
         }
  
         // scene containers are checked recursively
         if ((*it)->getType() == Scene::Layer::Type::SceneLayer) {
             const SceneLayer& container = (*it)->castTo<SceneLayer>();
             if (container.getScene().resolveMapping(layer, mapping)) {
                 mapping = container.getMapping() * mapping;
                 return true;
             }
         }
     }
     return false;
 }

◆ attachLayer()

void Scene::attachLayer ( Layer & layer )

Attaches an existing layer to the scene.

Definition at line 224 of file scene.cpp.

                                     {
     if (getLayerIndex(layer) >= 0)
         throw SceneIntegrityError(std::string("Layer ") + layer.getName() + " is already in the scene", *this);
     layers.push_back(&layer);
 }

◆ detachLayer()

Scene::Layer * Scene::detachLayer ( int index )

Detaches a layer from the scene.

Definition at line 231 of file scene.cpp.

                                         {
     Layer* l = layers[index];
     layers.erase(layers.begin() + index);
     return l;
 }

Member Data Documentation

◆ layers

std::vector<Layer*> Beatmup::Scene::layers

private

scene layers

Definition at line 41 of file scene.h.

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes