ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

A location layer. More...

#include <layer.h>

Inheritance diagram for Stark::Resources::Layer:
Collaboration diagram for Stark::Resources::Layer:

List of all members.

Public Types

enum  SubType { kLayer2D = 1, kLayer3D = 2 }

Public Member Functions

 Layer (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~Layer ()
virtual void readData (Formats::XRCReadStream *stream) override
 Deserialize the resource static data and initial state.
virtual void saveLoad (ResourceSerializer *serializer) override
 Persist / restore the resource state.
virtual void saveLoadCurrent (ResourceSerializer *serializer) override
 Persist / restore the resource state.
virtual Gfx::RenderEntryArray listRenderEntries ()=0
 Obtain the render entries for all items, including the background.
Gfx::LightEntryArray listLightEntries ()
 Obtain a list of render entries for all the lights in the layer.
void setScrollPosition (const Common::Point &position)
 Scroll the layer to the specified position.
Common::Point getScroll () const
 Get the current scroll for this layer.
void setScroll (const Common::Point &scroll)
 Set the current scroll for this layer.
void enable (bool enabled)
 Enable the layer.
bool isEnabled () const
 Is the layer enabled? Disabled layers are not drawn.

Static Public Member Functions

static Objectconstruct (Object *parent, byte subType, uint16 index, const Common::String &name)
 Layer factory.

Static Public Attributes

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

Protected Member Functions

void printData () override

Protected Attributes

Common::Point _scroll
float _scrollScale
bool _enabled

Detailed Description

A location layer.

Layers own the scene items

Definition at line 47 of file layer.h.


Member Enumeration Documentation

Enumerator:
kLayer2D 
kLayer3D 

Definition at line 51 of file layer.h.


Constructor & Destructor Documentation

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

Definition at line 55 of file layer.cpp.

Stark::Resources::Layer::~Layer (  )  [virtual]

Definition at line 52 of file layer.cpp.


Member Function Documentation

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

Layer factory.

Definition at line 41 of file layer.cpp.

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

Enable the layer.

Definition at line 91 of file layer.cpp.

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

Get the current scroll for this layer.

Definition at line 79 of file layer.cpp.

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

Is the layer enabled? Disabled layers are not drawn.

Definition at line 87 of file layer.cpp.

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

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

Definition at line 95 of file layer.cpp.

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

Obtain the render entries for all items, including the background.

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

void Stark::Resources::Layer::printData (  )  [override, protected, virtual]

Reimplemented from Stark::Resources::Object.

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

Definition at line 68 of file layer.cpp.

void Stark::Resources::Layer::readData ( Formats::XRCReadStream stream  )  [override, virtual]

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

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

Definition at line 62 of file layer.cpp.

void Stark::Resources::Layer::saveLoad ( ResourceSerializer serializer  )  [override, virtual]

Persist / restore the resource state.

Reimplemented from Stark::Resources::Object.

Definition at line 106 of file layer.cpp.

void Stark::Resources::Layer::saveLoadCurrent ( ResourceSerializer serializer  )  [override, virtual]

Persist / restore the resource state.

Called only for active locations

Reimplemented from Stark::Resources::Object.

Definition at line 110 of file layer.cpp.

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

Set the current scroll for this layer.

Definition at line 83 of file layer.cpp.

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

Scroll the layer to the specified position.

Definition at line 73 of file layer.cpp.


Member Data Documentation

Definition at line 93 of file layer.h.

Definition at line 91 of file layer.h.

Definition at line 92 of file layer.h.

const Type::ResourceType Stark::Resources::Layer::TYPE = Type::kLayer [static]

Definition at line 49 of file layer.h.


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


Generated on Sat Sep 21 2019 05:04:35 for ResidualVM by doxygen 1.7.1
curved edge   curved edge