ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Stark::Resources::Layer3D Class Reference

#include <layer.h>

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

Public Member Functions

 Layer3D (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void onAllLoaded () override
 
void onEnterLocation () override
 
Gfx::RenderEntryArray listRenderEntries () override
 
Gfx::RenderEntry * getBackgroundRenderEntry ()
 
- Public Member Functions inherited from Stark::Resources::Layer
 Layer (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void saveLoad (ResourceSerializer *serializer) override
 
void saveLoadCurrent (ResourceSerializer *serializer) override
 
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 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
 

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

bool _shouldRenderShadows
 
uint32 _maxShadowLength
 
float _nearClipPlane
 
float _farClipPlane
 
Item * _backgroundItem
 
Common::Array< Item * > _items
 
- Protected Attributes inherited from Stark::Resources::Layer
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
 

Additional Inherited Members

- Public Types inherited from Stark::Resources::Layer
enum  SubType { kLayer2D = 1, kLayer3D = 2 }
 
- Static Public Member Functions inherited from Stark::Resources::Layer
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 inherited from Stark::Resources::Layer
static const Type::ResourceType TYPE = Type::kLayer
 

Detailed Description

A 3D layer

3D layers contain 3D positioned items, a camera and a floorfield

Member Function Documentation

◆ readData()

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

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Layer.

◆ onAllLoaded()

void Stark::Resources::Layer3D::onAllLoaded ( )
overridevirtual

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::Object.

◆ onEnterLocation()

void Stark::Resources::Layer3D::onEnterLocation ( )
overridevirtual

Called when entering a location

Reimplemented from Stark::Resources::Object.

◆ listRenderEntries()

Gfx::RenderEntryArray Stark::Resources::Layer3D::listRenderEntries ( )
overridevirtual

Obtain the render entries for all items, including the background

Implements Stark::Resources::Layer.

◆ getBackgroundRenderEntry()

Gfx::RenderEntry* Stark::Resources::Layer3D::getBackgroundRenderEntry ( )

Obtain the render entry for the background item

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