ScummVM API documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Stark::Resources::AnimProp Class Reference
Inheritance diagram for Stark::Resources::AnimProp:
Stark::Resources::Anim Stark::Resources::Object

Public Member Functions

 AnimProp (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
void onPostRead () override
 
Visual * getVisual () override
 
uint32 getMovementSpeed () const override
 
- Public Member Functions inherited from Stark::Resources::Anim
 Anim (Object *parent, byte subType, uint16 index, const Common::String &name)
 
uint32 getCurrentFrame ()
 
virtual void selectFrame (uint32 frameIndex)
 
virtual void applyToItem (Item *item)
 
virtual void removeFromItem (Item *item)
 
bool isInUse () const
 
uint32 getActivity () const
 
virtual int getPointHotspotIndex (const Common::Point &point) const
 
virtual Common::Point getHotspotPosition (uint index) const
 
virtual void playAsAction (ItemVisual *item)
 
virtual bool isAtTime (uint32 time) const
 
virtual uint32 getIdleActionFrequency () const
 
virtual void shouldResetItem (bool resetItem)
 
virtual void resetItem ()
 
virtual bool isDone () 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 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
 

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::String _field_3C
 
Common::Array< Common::Path > _meshFilenames
 
Common::Path _textureFilename
 
uint32 _movementSpeed
 
Common::Path _archiveName
 
VisualProp * _visual
 
- Protected Attributes inherited from Stark::Resources::Anim
uint32 _activity
 
uint32 _currentFrame
 
uint32 _numFrames
 
int32 _refCount
 
- 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::Anim
enum  SubType { kAnimImages = 1, kAnimProp = 2, kAnimVideo = 3, kAnimSkeleton = 4 }
 
enum  ActionUsage { kActionUsagePassive = 1, kActionUsageActive = 2 }
 
enum  UIUsage { kUIUsageInventory = 1, kUIUsageUseCursorPassive = 4, kUIUsageUseCursorActive = 5 }
 
enum  ActorActivity {
  kActorActivityIdle = 1, kActorActivityWalk = 2, kActorActivityTalk = 3, kActorActivityRun = 6,
  kActorActivityIdleAction = 10
}
 
- Static Public Member Functions inherited from Stark::Resources::Anim
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::Anim
static const Type::ResourceType TYPE = Type::kAnim
 

Member Function Documentation

◆ readData()

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

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Anim.

◆ onPostRead()

void Stark::Resources::AnimProp::onPostRead ( )
overridevirtual

Called when the node's initialization is complete.

Allows to load additional data from file.

Reimplemented from Stark::Resources::Object.

◆ getVisual()

Visual* Stark::Resources::AnimProp::getVisual ( )
overridevirtual

Obtain the Visual to be used to render the animation

Implements Stark::Resources::Anim.

◆ getMovementSpeed()

uint32 Stark::Resources::AnimProp::getMovementSpeed ( ) const
overridevirtual

Get the anim movement speed in units per seconds

Reimplemented from Stark::Resources::Anim.

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