Beatmup::Scene::BitmapLayer Class Reference

Layer having an image to render. More...

#include <scene.h>

Inheritance diagram for Beatmup::Scene::BitmapLayer:

Public Member Functions
bool	testPoint (float x, float y) const
	Tests if a given point falls in the layer. More...
const AbstractBitmap *	getBitmap () const
void	setBitmap (AbstractBitmap *bitmap)
AffineMapping &	getBitmapMapping ()
const AffineMapping &	getBitmapMapping () const
void	setBitmapMapping (const AffineMapping &mapping)
color4i	getModulationColor () const
void	setModulationColor (color4i color)
Public Member Functions inherited from Beatmup::Scene::Layer
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 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
	BitmapLayer ()
	BitmapLayer (Type type)
GL::TextureHandler *	resolveContent (RenderingContext &context)
void	configure (RenderingContext &context, GL::TextureHandler *content)
	Configures current rendering program to render this layer. More...
void	render (RenderingContext &context)
Protected Member Functions inherited from Beatmup::Scene::Layer
	Layer (Type type)

Protected Attributes
float	invAr
	inverse aspect ratio of what is rendered (set by SceneRenderer) More...
AbstractBitmap *	bitmap
	content to display, used if the image source is set to BITMAP More...
AffineMapping	bitmapMapping
	bitmap mapping w.r.t. the layer mapping More...
color4i	modulation
	modulation color More...
Protected Attributes inherited from Beatmup::Scene::Layer
AffineMapping	mapping
	layer mapping More...
bool	visible
	layer visibility More...
bool	phantom
	if true, layer is ignored by selection by point More...

Friends
class	Scene
class	SceneRenderer

Additional Inherited Members
Public Types inherited from Beatmup::Scene::Layer
enum class	Type {   SceneLayer = 0 , BitmapLayer , MaskedBitmapLayer , ShapedBitmapLayer ,   ShadedBitmapLayer }

Detailed Description

Layer having an image to render.

The image has a position and orientation with respect to the layer. This is expressed with an affine mapping applied on top of the layer mapping.

Definition at line 158 of file scene.h.

Constructor & Destructor Documentation

BitmapLayer() [1/2]

Scene::BitmapLayer::BitmapLayer ( )

protected

Definition at line 264 of file scene.cpp.

                             :
    BitmapLayer(Type::BitmapLayer)
{}

BitmapLayer() [2/2]

Scene::BitmapLayer::BitmapLayer ( Type  type )

protected

Definition at line 268 of file scene.cpp.

                                      :
    Layer(type), invAr(0), bitmap(nullptr), bitmapMapping(), modulation(Color::WHITE)
{}

Member Function Documentation

resolveContent()

GL::TextureHandler * Scene::BitmapLayer::resolveContent ( RenderingContext &  context )

protected

Definition at line 273 of file scene.cpp.

                                                                            {
    if (bitmap)
            context.lockBitmap(bitmap);
    return bitmap;
}

configure()

void Scene::BitmapLayer::configure ( RenderingContext &  context, GL::TextureHandler *  content  )

protected

Configures current rendering program to render this layer.

Definition at line 279 of file scene.cpp.

                                                                                     {
    if (content) {
        invAr = content->getInvAspectRatio();
        context.getProgram().bindSampler(context.getGpu(), *content, "image", TextureParam::INTERP_LINEAR);
    }
    else
        invAr = 0;
 
    context.getProgram().setVector4("modulationColor", modulation);
}

render()

void Scene::BitmapLayer::render ( RenderingContext &  context )

protectedvirtual

Reimplemented from Beatmup::Scene::Layer.

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

Definition at line 291 of file scene.cpp.

                                                       {
    GL::TextureHandler* content = resolveContent(context);
    if (content) {
        // program selection
        switch (content->getTextureFormat()) {
        case GL::TextureHandler::TextureFormat::OES_Ext:
            context.enableProgram(GL::RenderingPrograms::Operation::BLEND_EXT);
            break;
        default:
            context.enableProgram(GL::RenderingPrograms::Operation::BLEND);
            break;
        }
 
        configure(context, content);
 
        AffineMapping arMapping(context.getMapping() * bitmapMapping);
        arMapping.matrix.scale(1.0f, invAr);
        context.getProgram().setMatrix3(GL::RenderingPrograms::MODELVIEW_MATRIX_ID, arMapping);
        context.blend();
    }
}

testPoint()

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

virtual

Tests if a given point falls in the layer.

Reimplemented from Beatmup::Scene::Layer.

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

Definition at line 314 of file scene.cpp.

                                                       {
    // no bitmap - no deal (if the source is set to bitmap)
    if (!bitmap)
        return false;
    return (mapping * bitmapMapping).isPointInside(x, y, 1, invAr);
}

getBitmap()

const AbstractBitmap* Beatmup::Scene::BitmapLayer::getBitmap ( ) const

inline

Definition at line 181 of file scene.h.

{ return bitmap; }

setBitmap()

void Beatmup::Scene::BitmapLayer::setBitmap ( AbstractBitmap *  bitmap )

inline

Definition at line 182 of file scene.h.

{ this->bitmap = bitmap; }

getBitmapMapping() [1/2]

AffineMapping& Beatmup::Scene::BitmapLayer::getBitmapMapping ( )

inline

Definition at line 184 of file scene.h.

{ return bitmapMapping; }

getBitmapMapping() [2/2]

const AffineMapping& Beatmup::Scene::BitmapLayer::getBitmapMapping ( ) const

inline

Definition at line 185 of file scene.h.

{ return bitmapMapping; }

setBitmapMapping()

void Beatmup::Scene::BitmapLayer::setBitmapMapping ( const AffineMapping &  mapping )

inline

Definition at line 186 of file scene.h.

{ this->bitmapMapping = mapping; }

getModulationColor()

color4i Beatmup::Scene::BitmapLayer::getModulationColor ( ) const

inline

Definition at line 188 of file scene.h.

{ return modulation; }

setModulationColor()

void Beatmup::Scene::BitmapLayer::setModulationColor ( color4i  color )

inline

Definition at line 189 of file scene.h.

{ this->modulation = color; }

Friends And Related Function Documentation

Scene

friend class Scene

friend

Definition at line 159 of file scene.h.

SceneRenderer

friend class SceneRenderer

friend

Definition at line 160 of file scene.h.

Member Data Documentation

invAr

float Beatmup::Scene::BitmapLayer::invAr

protected

inverse aspect ratio of what is rendered (set by SceneRenderer)

Definition at line 173 of file scene.h.

bitmap

AbstractBitmap* Beatmup::Scene::BitmapLayer::bitmap

protected

content to display, used if the image source is set to BITMAP

Definition at line 174 of file scene.h.

bitmapMapping

AffineMapping Beatmup::Scene::BitmapLayer::bitmapMapping

protected

bitmap mapping w.r.t. the layer mapping

Definition at line 175 of file scene.h.

modulation

color4i Beatmup::Scene::BitmapLayer::modulation

protected

modulation color

Definition at line 176 of file scene.h.

---

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

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