Sprite Class Reference

#include <Sprite.hxx>

Collaboration diagram for Sprite:

Public Member Functions
	Sprite (Point isoCoordinates)
virtual	~Sprite ()=default
void	render () const
void	refresh (const Layer &layer=Layer::NONE)
void	setTexture (SDL_Texture *m_texture, Layer layer=Layer::TERRAIN)
void	setClipRect (SDL_Rect clipRect, Layer layer=Layer::TERRAIN)
void	setDestRect (SDL_Rect clipRect, Layer layer=Layer::TERRAIN)
void	clearSprite (Layer layer)
void	setRenderFlag (const Layer &layer, bool render)
	enable/disable rendering for this sprite on a specific layer More...
SDL_Rect	getDestRect (Layer layer=Layer::TERRAIN)
SDL_Rect	getClipRect (Layer layer=Layer::TERRAIN)
SDL_Rect	getActiveClipRect ()
SDL_Rect	getActiveDestRect ()
void	setSpriteTranparencyFactor (const Layer &layer, unsigned char alpha)
bool	isLayerUsed (Layer layer)

Public Attributes
size_t	spriteCount = 1
bool	highlightSprite = false
SpriteRGBColor	highlightColor = SpriteHighlightColor::GRAY
Point	isoCoordinates {0, 0, 0, 0}

Private Attributes
SDL_Point	m_screenCoordinates {0, 0}
bool	m_needsRefresh = false
double	m_currentZoomLevel = 0
std::vector< SpriteData >	m_SpriteData
std::vector< bool >	m_renderLayer

Detailed Description

Definition at line 32 of file Sprite.hxx.

Constructor & Destructor Documentation

Sprite()

Sprite::Sprite ( Point  isoCoordinates )

explicit

Definition at line 17 of file Sprite.cxx.

    : isoCoordinates(_isoCoordinates), m_SpriteData(LAYERS_COUNT), m_renderLayer(LAYERS_COUNT, true)
{
  m_screenCoordinates = convertIsoToScreenCoordinates(_isoCoordinates);
}

Here is the call graph for this function:

~Sprite()

virtual Sprite::~Sprite ( )

virtualdefault

Member Function Documentation

clearSprite()

void Sprite::clearSprite

(

Layer

layer

)

Definition at line 174 of file Sprite.cxx.

{
  m_SpriteData[layer].clipRect = {0, 0, 0, 0};
  m_SpriteData[layer].destRect = {0, 0, 0, 0};
  m_SpriteData[layer].texture = nullptr;
}

getActiveClipRect()

SDL_Rect Sprite::getActiveClipRect

(

)

Definition at line 142 of file Sprite.cxx.

{
  if (MapLayers::isLayerActive(Layer::BUILDINGS) && m_SpriteData[Layer::BUILDINGS].clipRect.w != 0 &&
      m_SpriteData[Layer::BUILDINGS].clipRect.h != 0)
  {
    return m_SpriteData[Layer::BUILDINGS].clipRect;
  }
  else if (MapLayers::isLayerActive(Layer::TERRAIN))
  {
    return m_SpriteData[Layer::TERRAIN].clipRect;
  }
  return {0, 0, 0, 0};
}

Here is the call graph for this function:

getActiveDestRect()

SDL_Rect Sprite::getActiveDestRect

(

)

Definition at line 160 of file Sprite.cxx.

{
  if (MapLayers::isLayerActive(Layer::BUILDINGS) && m_SpriteData[Layer::BUILDINGS].destRect.w != 0 &&
      m_SpriteData[Layer::BUILDINGS].destRect.h != 0)
  {
    return m_SpriteData[Layer::BUILDINGS].destRect;
  }
  else if (MapLayers::isLayerActive(Layer::TERRAIN))
  {
    return m_SpriteData[Layer::TERRAIN].destRect;
  }
  return {0, 0, 0, 0};
}

Here is the call graph for this function:

getClipRect()

SDL_Rect Sprite::getClipRect ( Layer  layer = Layer::TERRAIN )

inline

Definition at line 59 of file Sprite.hxx.

{ return m_SpriteData[layer].clipRect; };

getDestRect()

SDL_Rect Sprite::getDestRect ( Layer  layer = Layer::TERRAIN )

inline

Definition at line 58 of file Sprite.hxx.

{ return m_SpriteData[layer].destRect; };

isLayerUsed()

bool Sprite::isLayerUsed

(

Layer

layer

)

Definition at line 155 of file Sprite.cxx.

{
  return (MapLayers::isLayerActive(layer) && m_SpriteData[layer].clipRect.w != 0 && m_SpriteData[layer].clipRect.h != 0);
}

Here is the call graph for this function:

refresh()

void Sprite::refresh

(

const Layer &

layer = Layer::NONE

)

Definition at line 73 of file Sprite.cxx.

{
  if (m_currentZoomLevel != Camera::instance().zoomLevel() || m_needsRefresh)
  {
    for (auto currentLayer : allLayersOrdered)
    {
      if (m_SpriteData[currentLayer].texture)
      {
        if (layer != NONE && currentLayer != layer)
        {
          continue;
        }
        m_currentZoomLevel = Camera::instance().zoomLevel();
        int spriteSheetHeight = 0;
        SDL_QueryTexture(m_SpriteData[currentLayer].texture, nullptr, nullptr, nullptr, &spriteSheetHeight);
        // we need to offset the cliprect.y coodinate, because we've moved the "originpoint" for drawing the sprite to the screen on the bottom.
        // the sprites need to start at the bottom, so the cliprect must too.
        m_SpriteData[currentLayer].clipRect.y = spriteSheetHeight - m_SpriteData[currentLayer].clipRect.h;
 
        if (m_SpriteData[currentLayer].clipRect.w != 0)
        {
          m_SpriteData[currentLayer].destRect.w =
              static_cast<int>(std::round(static_cast<double>(m_SpriteData[currentLayer].clipRect.w) * m_currentZoomLevel));
          m_SpriteData[currentLayer].destRect.h =
              static_cast<int>(std::round(static_cast<double>(m_SpriteData[currentLayer].clipRect.h) * m_currentZoomLevel));
        }
        else
        {
          SDL_QueryTexture(m_SpriteData[currentLayer].texture, nullptr, nullptr, &m_SpriteData[currentLayer].destRect.w,
                           &m_SpriteData[currentLayer].destRect.h);
 
          m_SpriteData[currentLayer].destRect.w =
              static_cast<int>(std::round(static_cast<double>(m_SpriteData[currentLayer].clipRect.w) * m_currentZoomLevel));
          m_SpriteData[currentLayer].destRect.h =
              static_cast<int>(std::round(static_cast<double>(m_SpriteData[currentLayer].clipRect.h) * m_currentZoomLevel));
        }
      }
    }
  }
 
  // convert this tiles isometric coordinates to screen coordinates (with camera offset / zoomlevel taken into account.
  m_screenCoordinates = convertIsoToScreenCoordinates(isoCoordinates);
 
  for (auto &it : m_SpriteData)
  {
    if (it.texture != nullptr)
    {
      // render the sprite in the middle of its bounding box so bigger than 1x1 sprites will render correctly
      it.destRect.x = m_screenCoordinates.x - (it.destRect.w / 2);
      // change y coordinates with sprites height taken into account to render the sprite at its base and not at its top.
      it.destRect.y = m_screenCoordinates.y - it.destRect.h;
    }
  }
 
  m_needsRefresh = false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

render()

void Sprite::render

(

)

const

Definition at line 23 of file Sprite.cxx.

{
#ifdef MICROPROFILE_ENABLED
  MICROPROFILE_SCOPEI("Map", "Sprite render", MP_RED);
#endif
  for (auto currentLayer : allLayersOrdered)
  {
    if (MapLayers::isLayerActive(currentLayer) && m_SpriteData[currentLayer].texture && m_renderLayer[currentLayer])
    {
      // Don't draw zones when there is a building on this sprite
      if (currentLayer == Layer::ZONE && m_SpriteData[Layer::BUILDINGS].texture)
      {
        continue;
      }
      if (highlightSprite)
      {
        SDL_SetTextureColorMod(m_SpriteData[currentLayer].texture, highlightColor.r, highlightColor.g, highlightColor.b);
      }
 
      if (GameStates::instance().layerEditMode == LayerEditMode::BLUEPRINT && currentLayer != Layer::BLUEPRINT &&
          currentLayer != Layer::UNDERGROUND)
      {
        SDL_SetTextureAlphaMod(m_SpriteData[currentLayer].texture, 80);
      }
      else
      {
        SDL_SetTextureAlphaMod(m_SpriteData[currentLayer].texture, m_SpriteData[currentLayer].alpha);
      }
 
      if (m_SpriteData[currentLayer].clipRect.w != 0)
      {
        SDL_RenderCopy(WindowManager::instance().getRenderer(), m_SpriteData[currentLayer].texture,
                       &m_SpriteData[currentLayer].clipRect, &m_SpriteData[currentLayer].destRect);
      }
      else
      {
        SDL_RenderCopy(WindowManager::instance().getRenderer(), m_SpriteData[currentLayer].texture, nullptr,
                       &m_SpriteData[currentLayer].destRect);
      }
 
      if (highlightSprite)
      {
        SDL_SetTextureColorMod(m_SpriteData[currentLayer].texture, 255, 255, 255);
      }
 
      SDL_SetTextureAlphaMod(m_SpriteData[currentLayer].texture, 255);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

setClipRect()

void Sprite::setClipRect	(	SDL_Rect	clipRect,
		Layer	layer = Layer::TERRAIN
	)

Definition at line 139 of file Sprite.cxx.

{ m_SpriteData[layer].clipRect = clipRect; }

setDestRect()

void Sprite::setDestRect	(	SDL_Rect	clipRect,
		Layer	layer = Layer::TERRAIN
	)

Definition at line 140 of file Sprite.cxx.

{ m_SpriteData[layer].destRect = destRect; }

setRenderFlag()

void Sprite::setRenderFlag ( const Layer &  layer, bool  render  )

inline

enable/disable rendering for this sprite on a specific layer

Parameters

layer	which layer to set the flag for
render	if this sprite should render this layer

Definition at line 52 of file Sprite.hxx.

{ m_renderLayer[layer] = render; };

Here is the call graph for this function:

Here is the caller graph for this function:

setSpriteTranparencyFactor()

void Sprite::setSpriteTranparencyFactor ( const Layer &  layer, unsigned char  alpha  )

inline

Definition at line 62 of file Sprite.hxx.

{ m_SpriteData[layer].alpha = alpha; }

setTexture()

void Sprite::setTexture	(	SDL_Texture *	m_texture,
		Layer	layer = Layer::TERRAIN
	)

Definition at line 130 of file Sprite.cxx.

{
  if (!texture)
    throw UIError(TRACE_INFO "Called Sprite::setTexture() with a non valid texture");
  m_SpriteData[layer].texture = texture;
  m_needsRefresh = true;
  refresh(layer);
}

Here is the call graph for this function:

Member Data Documentation

highlightColor

SpriteRGBColor Sprite::highlightColor = SpriteHighlightColor::GRAY

Definition at line 56 of file Sprite.hxx.

highlightSprite

bool Sprite::highlightSprite = false

Definition at line 55 of file Sprite.hxx.

isoCoordinates

Point Sprite::isoCoordinates {0, 0, 0, 0}

Definition at line 65 of file Sprite.hxx.

m_currentZoomLevel

double Sprite::m_currentZoomLevel = 0

private

Definition at line 71 of file Sprite.hxx.

m_needsRefresh

bool Sprite::m_needsRefresh = false

private

Definition at line 70 of file Sprite.hxx.

m_renderLayer

std::vector<bool> Sprite::m_renderLayer

private

Definition at line 74 of file Sprite.hxx.

m_screenCoordinates

SDL_Point Sprite::m_screenCoordinates {0, 0}

private

Definition at line 68 of file Sprite.hxx.

m_SpriteData

std::vector<SpriteData> Sprite::m_SpriteData

private

Definition at line 73 of file Sprite.hxx.

spriteCount

size_t Sprite::spriteCount = 1

Definition at line 54 of file Sprite.hxx.

---

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

• src/engine/Sprite.hxx
• src/engine/Sprite.cxx