JugiMap Framework
SpriteLayerNC Class Reference

Extended SpriteLayer class for nCine. More...

#include <jmNCine.h>

Inherits SpriteLayer.

Public Member Functions

virtual void RemoveAndDeleteSprite (Sprite *_sprite) override
 Remove and delete the given sprite *_sprite* from this sprite layer. More...
 
- Public Member Functions inherited from SpriteLayer
 SpriteLayer ()
 Constructor. More...
 
virtual void InitEngineObjects () override
 Initialize all engine objects related to this layer and its content. More...
 
virtual void InitLayerParameters () override
 Initialize layer properties from the parameters set in the editor. More...
 
virtual void UpdateEngineObjects () override
 Update all engine objects related to this layer and its content. More...
 
virtual void DrawEngineObjects () override
 Draw all engine objects related to this layer and its content. More...
 
std::vector< Sprite * > & GetSprites ()
 Returns a reference to the vector of stored sprites in this sprite layer. More...
 
virtual void UpdateBoundingBox () override
 Update the map bounding box of this sprite layer. More...
 
void SetAlpha (float _alpha)
 Sets the alpha factor of this sprite layer to the given *_alpha*. More...
 
float GetAlpha ()
 Returns the alpha factor of this sprite layer. More...
 
void SetBlend (Blend _blend)
 Sets the blend factor of this sprite layer to the given *_blend*. More...
 
Blend GetBlend ()
 Returns the blend factor of this sprite layer. More...
 
void AddSprite (Sprite *_sprite)
 Adds a new sprite to this sprite layer. More...
 
void CaptureForLerpDrawing ()
 Capture the sprite properties, usually the position only, required for the lerp drawing. More...
 
void SetSpritesChanged (bool _spritesChanged)
 Set the sprites changed flag which indicates that this sprite layer has sprites with changed properites. More...
 
bool IsSpritesChanged ()
 Returns 'true' if this sprite layer has sprites with changed properties; otherwise returns false. More...
 
void SetSpritesChangeFlag (int _spritesChangeFlag)
 Set the sprites changes flag to the given **_changedFlags**. More...
 
void AppendToSpritesChangeFlag (int _spritesChangeFlag)
 Append the given *_spritesChangeFlag* to the current sprites changes flag using bitwise operation. More...
 
int GetSpritesChangeFlag ()
 Returns the sprites changes flag. More...
 
bool IsEditorTileLayer ()
 Returns true if this layer was a tile layer in JugiMap Editor; if it was a sprite layer returns false. More...
 
- Public Member Functions inherited from Layer
 Layer ()
 Constructor. More...
 
MapGetMap ()
 Returns a Map object where this layer is stored. More...
 
ComposedSpriteGetParentComposedSprite ()
 Returns a ComposedSprite where this layer is stored or nullptr if it is stored in a map. More...
 
bool IsMapLayer ()
 Returns true if this layer is stored in a Map; if it's stored in a ComposedSprite returns false. More...
 
LayerKind GetKind ()
 Returns the kind of this layer. More...
 
std::string GetName ()
 Returns the name of this layer. More...
 
std::vector< jugimap::Parameter > & GetParameters ()
 Returns a reference to the vector of stored paramters in this layer. More...
 
int GetZOrder ()
 Returns the zOrder of this layer. More...
 
Rectf GetBoundingBox ()
 Returns the map bounding box of this layer. More...
 
LayerType GetLayerType ()
 Returns the LayerType factor of this layer. More...
 
StretchingVariant GetStretchingVariant ()
 Returns the AlignX factor of this layer. More...
 
Vec2i GetAlignPosition ()
 Returns the allign position factor of this layer. More...
 
Vec2f GetAlignOffset ()
 Returns the allign offset factor of this layer. More...
 
Vec2f GetLayersPlaneSize ()
 Returns the layers plane size of this layer. More...
 
Vec2f GetParallaxFactor ()
 Returns the ParallaxLayerMode factor of this layer. More...
 
Vec2f GetParallaxOffset ()
 Returns the parallax offset of this layer. More...
 
void _SetName (const std::string &_name)
 Returns the ScreenLayerMode factor of this layer. More...
 
void _SetKind (LayerKind _kind)
 Sets the kind of this layer to the given *_kind*. More...
 
void _SetLayerType (LayerType _layerType)
 Sets the layer mode of this layer to the given *_layerType*. More...
 
void _SetParallaxFactor (Vec2f _parallaxFactor)
 Sets the parallax factor of this layer to the given *_parallaxFactor*. More...
 
void _SetAlignPosition (Vec2i _alignPosition)
 Sets the align position of this layer to the given *_alignPosition*. More...
 
void _SetAlignOffset (Vec2f _alignOffset)
 Sets the align offset of this layer to the given *_alignOffset*. More...
 
void _SetAttachToLayer (std::string _attachToLayer)
 Sets the 'attachToLayer' of this layer to the given *_attachToLayer*. More...
 
void _SetStretchingVariant (StretchingVariant _stretchingVariant)
 Sets the stretching variant of this layer to the given *_stretchingVariant*. More...
 
void _SetZOrder (int _zOrder)
 Sets the z-order factor of this layer to the given *_zOrder*. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SpriteLayer
virtual ~SpriteLayer () override
 Destructor. More...
 
- Protected Member Functions inherited from Layer
virtual ~Layer ()
 Destructor. More...
 

Detailed Description

Extended SpriteLayer class for nCine.

Member Function Documentation

◆ RemoveAndDeleteSprite()

void RemoveAndDeleteSprite ( Sprite _sprite)
overridevirtual

Remove and delete the given sprite *_sprite* from this sprite layer.

If the sprite belong to other layer it will not be deleted.

Reimplemented from SpriteLayer.


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