AmbientLayer Class Reference

#include <ambientlayer.h>

Inheritance diagram for AmbientLayer:

Public Member Functions
	AmbientLayer (const std::string &name, Image *const img, const float parallax, const float parallaxY, const float posX, const float posY, const float speedX, const float speedY, const bool keepRatio, const int mask)
	~AmbientLayer ()
void	update (const int timePassed, const float dx, const float dy)
void	draw (Graphics *const graphics, const int x, const int y) const
int	calcMemoryLocal () const
std::string	getCounterName () const
Public Member Functions inherited from MemoryCounter
	MemoryCounter ()
virtual	~MemoryCounter ()
int	calcMemory (const int level) const
virtual int	calcMemoryChilds (const int level) const

Private Attributes
const std::string	mName
Image *	mImage
float	mParallaxX
float	mParallaxY
float	mPosX
float	mPosY
float	mSpeedX
float	mSpeedY
int	mMask
bool	mKeepRatio

Friends
class	Map

Detailed Description

Definition at line 34 of file ambientlayer.h.

Constructor & Destructor Documentation

AmbientLayer()

AmbientLayer::AmbientLayer	(	const std::string &	name,
		Image *const	img,
		const float	parallax,
		const float	parallaxY,
		const float	posX,
		const float	posY,
		const float	speedX,
		const float	speedY,
		const bool	keepRatio,
		const int	mask
	)

Constructor.

Parameters

img	the image this overlay displays
parallax	scroll factor based on camera position
speedX	scrolling speed in x-direction
speedY	scrolling speed in y-direction
keepRatio	rescale the image to keep the same ratio than in 800x600 resolution mode.

Definition at line 37 of file ambientlayer.cpp.

                                           :
    MemoryCounter(),
    mName(name),
    mImage(img),
    mParallaxX(parallaxX),
    mParallaxY(parallaxY),
    mPosX(posX),
    mPosY(posY),
    mSpeedX(speedX),
    mSpeedY(speedY),
    mMask(mask),
    mKeepRatio(keepRatio)
{
    if (mImage == nullptr)
        return;
 
    if (keepRatio &&
        imageHelper->useOpenGL() == RENDER_SOFTWARE)
    {
        const int width = mainGraphics->mWidth;
        const int height = mainGraphics->mHeight;
        if (width != defaultScreenWidth && height != defaultScreenHeight)
        {
            // Rescale the overlay to keep the ratio as if we were on
            // the default resolution...
            Image *const rescaledOverlay = Loader::getRescaled(
                mImage,
                CAST_S32(mImage->mBounds.w) /
                defaultScreenWidth * width,
                CAST_S32(mImage->mBounds.h) /
                defaultScreenHeight * height);
 
            if (rescaledOverlay != nullptr)
                mImage = rescaledOverlay;
            else
                mImage->incRef();
            return;
        }
    }
    mImage->incRef();
}

References CAST_S32, defaultScreenHeight, defaultScreenWidth, Loader::getRescaled(), imageHelper, mainGraphics, Graphics::mHeight, mImage, Graphics::mWidth, RENDER_SOFTWARE, and ImageHelper::useOpenGL().

Referenced by calcMemoryLocal().

~AmbientLayer()

AmbientLayer::~AmbientLayer

(

)

Definition at line 88 of file ambientlayer.cpp.

{
    if (mImage != nullptr)
    {
        mImage->decRef();
        mImage = nullptr;
    }
}

References mImage.

Member Function Documentation

calcMemoryLocal()

int AmbientLayer::calcMemoryLocal ( ) const

virtual

Reimplemented from MemoryCounter.

Definition at line 152 of file ambientlayer.cpp.

{
    return static_cast<int>(sizeof(AmbientLayer) +
        mName.capacity());
}

References AmbientLayer(), and mName.

draw()

void AmbientLayer::draw	(	Graphics *const	graphics,
		const int	x,
		const int	y
	)		const

Definition at line 127 of file ambientlayer.cpp.

{
    if (mImage == nullptr)
        return;
 
    if (imageHelper->useOpenGL() == RENDER_SOFTWARE ||
        !mKeepRatio)
    {
        graphics->drawPattern(mImage, CAST_S32(-mPosX),
            CAST_S32(-mPosY), x + CAST_S32(mPosX),
            y + CAST_S32(mPosY));
    }
    else
    {
        graphics->drawRescaledPattern(mImage, CAST_S32(-mPosX),
                CAST_S32(-mPosY), x + CAST_S32(mPosX),
                y + CAST_S32(mPosY),
                CAST_S32(mImage->mBounds.w)
                / defaultScreenWidth * graphics->mWidth,
                CAST_S32(mImage->mBounds.h) / defaultScreenHeight
                * graphics->mHeight);
    }
}

References CAST_S32, defaultScreenHeight, defaultScreenWidth, Graphics::drawPattern(), Graphics::drawRescaledPattern(), imageHelper, Graphics::mHeight, mImage, mKeepRatio, mPosX, mPosY, Graphics::mWidth, RENDER_SOFTWARE, ImageHelper::useOpenGL(), x, and y.

getCounterName()

std::string AmbientLayer::getCounterName ( ) const

inlinevirtual

Reimplemented from MemoryCounter.

Definition at line 74 of file ambientlayer.h.

        { return mName; }

References mName.

update()

void AmbientLayer::update	(	const int	timePassed,
		const float	dx,
		const float	dy
	)

Definition at line 97 of file ambientlayer.cpp.

{
    if (mImage == nullptr)
        return;
 
    const float time = static_cast<float>(timePassed) / 10;
    // Self scrolling of the overlay
    mPosX -= mSpeedX * time;
    mPosY -= mSpeedY * time;
 
    // Parallax scrolling
    mPosX += dx * mParallaxX;
    mPosY += dy * mParallaxY;
 
    const SDL_Rect &rect = mImage->mBounds;
    const float imgW = static_cast<float>(rect.w);
    const float imgH = static_cast<float>(rect.h);
 
    // Wrap values
    while (mPosX > imgW)
        mPosX -= imgW;
    while (mPosX < 0)
        mPosX += imgW;
 
    while (mPosY > imgH)
        mPosY -= imgH;
    while (mPosY < 0)
        mPosY += imgH;
}

References mImage, mParallaxX, mParallaxY, mPosX, mPosY, mSpeedX, and mSpeedY.

Referenced by Map::updateAmbientLayers().

Friends And Related Function Documentation

Map

friend class Map

friend

Definition at line 37 of file ambientlayer.h.

Field Documentation

mImage

Image* AmbientLayer::mImage

private

Definition at line 79 of file ambientlayer.h.

Referenced by AmbientLayer(), draw(), update(), and ~AmbientLayer().

mKeepRatio

bool AmbientLayer::mKeepRatio

private

Keep overlay ratio on every resolution

Definition at line 87 of file ambientlayer.h.

Referenced by draw().

mMask

int AmbientLayer::mMask

private

Definition at line 86 of file ambientlayer.h.

Referenced by Map::updateAmbientLayers().

mName

const std::string AmbientLayer::mName

private

Definition at line 78 of file ambientlayer.h.

Referenced by calcMemoryLocal(), and getCounterName().

mParallaxX

float AmbientLayer::mParallaxX

private

Definition at line 80 of file ambientlayer.h.

Referenced by update().

mParallaxY

float AmbientLayer::mParallaxY

private

Definition at line 81 of file ambientlayer.h.

Referenced by update().

mPosX

float AmbientLayer::mPosX

private

Current layer X position.

Definition at line 82 of file ambientlayer.h.

Referenced by draw(), and update().

mPosY

float AmbientLayer::mPosY

private

Current layer Y position.

Definition at line 83 of file ambientlayer.h.

Referenced by draw(), and update().

mSpeedX

float AmbientLayer::mSpeedX

private

Scrolling speed in X direction.

Definition at line 84 of file ambientlayer.h.

Referenced by update().

mSpeedY

float AmbientLayer::mSpeedY

private

Scrolling speed in Y direction.

Definition at line 85 of file ambientlayer.h.

Referenced by update().

---

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

• src/resources/ambientlayer.h (986a3bf)
• src/resources/ambientlayer.cpp (986a3bf)