ScummVM API documentation
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Stark::Resources::Layer Class Referenceabstract

#include <layer.h>

Inheritance diagram for Stark::Resources::Layer:
Stark::Resources::Object Stark::Resources::Layer2D Stark::Resources::Layer3D

Public Types

enum  SubType { kLayer2D = 1, kLayer3D = 2 }
 

Public Member Functions

 Layer (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void saveLoad (ResourceSerializer *serializer) override
 
void saveLoadCurrent (ResourceSerializer *serializer) override
 
virtual Gfx::RenderEntryArray listRenderEntries ()=0
 
Gfx::LightEntryArray listLightEntries ()
 
void setScrollPosition (const Common::Point &position)
 
Common::Point getScroll () const
 
void setScroll (const Common::Point &scroll)
 
void enable (bool enabled)
 
bool isEnabled () const
 
- Public Member Functions inherited from Stark::Resources::Object
Type getType () const
 
byte getSubType () const
 
uint16 getIndex () const
 
Common::String getIndexAsString () const
 
Common::String getName () const
 
virtual void onPostRead ()
 
virtual void onAllLoaded ()
 
virtual void onEnterLocation ()
 
virtual void onGameLoop ()
 
virtual void onEnginePause (bool pause)
 
virtual void onExitLocation ()
 
virtual void onPreDestroy ()
 
template<class T >
T * findParent ()
 
Object * findChildWithIndex (Type type, uint16 index, int subType=-1) const
 
Object * findChildWithOrder (Type type, uint16 order, int subType=-1) const
 
Object * findChildWithName (Type type, const Common::String &name, int subType=-1) const
 
template<class T >
T * findChild (bool mustBeUnique=true) const
 
template<class T >
T * findChildWithSubtype (int subType, bool mustBeUnique=true) const
 
template<class T >
T * findChildWithIndex (uint16 index, int subType=-1) const
 
template<class T >
T * findChildWithOrder (uint16 order, int subType=-1) const
 
template<class T >
T * findChildWithName (const Common::String &name, int subType=-1) const
 
template<class T >
Common::Array< T * > listChildren (int subType=-1) const
 
template<class T >
Common::Array< T * > listChildrenRecursive (int subType=-1)
 
void addChild (Object *child)
 
virtual void print (uint depth=0)
 
template<>
Object * cast (Object *resource)
 
template<>
Object * findParent ()
 
template<>
Common::Array< Object * > listChildren (int subType) const
 

Static Public Member Functions

static Object * construct (Object *parent, byte subType, uint16 index, const Common::String &name)
 
- Static Public Member Functions inherited from Stark::Resources::Object
template<class T >
static T * cast (Object *resource)
 

Static Public Attributes

static const Type::ResourceType TYPE = Type::kLayer
 

Protected Member Functions

void printData () override
 
- Protected Member Functions inherited from Stark::Resources::Object
 Object (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void printWithDepth (uint depth, const Common::String &string) const
 
void printDescription (uint depth) const
 

Protected Attributes

Common::Point _scroll
 
float _scrollScale
 
bool _enabled
 
- Protected Attributes inherited from Stark::Resources::Object
Type _type
 
byte _subType
 
uint16 _index
 
Common::String _name
 
Object * _parent
 
Common::Array< Object * > _children
 

Detailed Description

A location layer

Layers own the scene items

Member Function Documentation

◆ construct()

static Object* Stark::Resources::Layer::construct ( Object *  parent,
byte  subType,
uint16  index,
const Common::String &  name 
)
static

Layer factory

◆ readData()

void Stark::Resources::Layer::readData ( Formats::XRCReadStream *  stream)
overridevirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

Reimplemented in Stark::Resources::Layer3D, and Stark::Resources::Layer2D.

◆ saveLoad()

void Stark::Resources::Layer::saveLoad ( ResourceSerializer *  serializer)
overridevirtual

Persist / restore the resource state

Reimplemented from Stark::Resources::Object.

◆ saveLoadCurrent()

void Stark::Resources::Layer::saveLoadCurrent ( ResourceSerializer *  serializer)
overridevirtual

Persist / restore the resource state

Called only for active locations

Reimplemented from Stark::Resources::Object.

◆ listRenderEntries()

virtual Gfx::RenderEntryArray Stark::Resources::Layer::listRenderEntries ( )
pure virtual

Obtain the render entries for all items, including the background

Implemented in Stark::Resources::Layer3D, and Stark::Resources::Layer2D.

◆ listLightEntries()

Gfx::LightEntryArray Stark::Resources::Layer::listLightEntries ( )

Obtain a list of render entries for all the lights in the layer

◆ setScrollPosition()

void Stark::Resources::Layer::setScrollPosition ( const Common::Point &  position)

Scroll the layer to the specified position

◆ getScroll()

Common::Point Stark::Resources::Layer::getScroll ( ) const

Get the current scroll for this layer

◆ setScroll()

void Stark::Resources::Layer::setScroll ( const Common::Point &  scroll)

Set the current scroll for this layer

◆ enable()

void Stark::Resources::Layer::enable ( bool  enabled)

Enable the layer

◆ isEnabled()

bool Stark::Resources::Layer::isEnabled ( ) const

Is the layer enabled? Disabled layers are not drawn.

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