ScummVM API documentation
Stark::Resources::Image Class Referenceabstract

#include <image.h>

Inheritance diagram for Stark::Resources::Image:
Stark::Resources::Object Stark::Resources::ImageStill Stark::Resources::ImageText

Public Types

enum  SubType { kImageSub2 = 2, kImageSub3 = 3, kImageText = 4 }
 
typedef Common::Array< Common::PointPolygon
 

Public Member Functions

 Image (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
virtual VisualgetVisual ()
 
int indexForPoint (const Common::Point &point) const
 
Common::Point getHotspotPosition (uint index) 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 saveLoad (ResourceSerializer *serializer)
 
virtual void saveLoadCurrent (ResourceSerializer *serializer)
 
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 ()
 
ObjectfindChildWithIndex (Type type, uint16 index, int subType=-1) const
 
ObjectfindChildWithOrder (Type type, uint16 order, int subType=-1) const
 
ObjectfindChildWithName (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<>
Objectcast (Object *resource)
 
template<>
ObjectfindParent ()
 
template<>
Common::Array< Object * > listChildren (int subType) const
 

Static Public Member Functions

static Objectconstruct (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::kImage
 

Protected Member Functions

void printData () override
 
bool isPointInPolygon (const Polygon &polygon, const Common::Point &point) const
 
virtual void initVisual ()=0
 
- 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::Path _filename
 
Common::Path _archiveName
 
Visual_visual
 
bool _transparent
 
uint32 _transparentColor
 
uint32 _field_44_ADF
 
uint32 _field_48_ADF
 
Common::Point _hotspot
 
Common::Array< Polygon_polygons
 
- 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 still image resource

Member Function Documentation

◆ construct()

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

Image factory

◆ readData()

void Stark::Resources::Image::readData ( Formats::XRCReadStream stream)
overridevirtual

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Object.

Reimplemented in Stark::Resources::ImageText, and Stark::Resources::ImageStill.

◆ getVisual()

virtual Visual* Stark::Resources::Image::getVisual ( )
virtual

Initialize the renderable for the image

◆ indexForPoint()

int Stark::Resources::Image::indexForPoint ( const Common::Point point) const

Get the pat-table index for a given point

◆ getHotspotPosition()

Common::Point Stark::Resources::Image::getHotspotPosition ( uint  index) const

Get the hotspot position for a given index of a pat-table


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