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

Stark::Resources::ItemTemplate Class Reference

An item template. More...

#include <item.h>

Inheritance diagram for Stark::Resources::ItemTemplate:
Collaboration diagram for Stark::Resources::ItemTemplate:

List of all members.

Public Member Functions

 ItemTemplate (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~ItemTemplate ()
void onAllLoaded () override
 Called when the resource sub-tree is entirely loaded.
void onEnterLocation () override
 Called when entering a location.
void saveLoadCurrent (ResourceSerializer *serializer) override
 Persist / restore the resource state.
ItemVisualgetSceneInstance () override
 Obtain the concrete instance of an item template.
void setAnimHierarchy (AnimHierarchy *animHierarchy) override
 Set the currently active anim hierachy.
virtual BonesMeshfindBonesMesh ()=0
 Obtain the bone mesh to use to render the item.
virtual TextureSetfindTextureSet (uint32 textureType)=0
 Obtain the texture to use to render the item.
virtual AnimHierarchyfindStockAnimHierarchy ()=0
 Obtain the animation hierarchy to fetch animations from.
void setStockAnimHierachy (AnimHierarchy *animHierarchy)
 Define the anim hierarchy to be persisted across locations.
void setBonesMesh (int32 index)
 Change the item's mesh.
void setTexture (int32 index, uint32 textureType)
 Set the mesh main or face texture.
void setInstanciatedItem (Item *instance)
 Set the scene instanciation for this template.

Protected Attributes

int32 _meshIndex
int32 _textureNormalIndex
int32 _textureFaceIndex
int32 _animHierarchyIndex
Item_instanciatedItem
ItemTemplate_referencedItem

Detailed Description

An item template.

Item templates need to be instanciated into renderable items to be displayed

Definition at line 215 of file item.h.


Constructor & Destructor Documentation

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

Definition at line 430 of file item.cpp.

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

Definition at line 427 of file item.cpp.


Member Function Documentation

virtual BonesMesh* Stark::Resources::ItemTemplate::findBonesMesh (  )  [pure virtual]

Obtain the bone mesh to use to render the item.

Implemented in Stark::Resources::GlobalItemTemplate, and Stark::Resources::LevelItemTemplate.

virtual AnimHierarchy* Stark::Resources::ItemTemplate::findStockAnimHierarchy (  )  [pure virtual]

Obtain the animation hierarchy to fetch animations from.

Implemented in Stark::Resources::GlobalItemTemplate, and Stark::Resources::LevelItemTemplate.

virtual TextureSet* Stark::Resources::ItemTemplate::findTextureSet ( uint32  textureType  )  [pure virtual]

Obtain the texture to use to render the item.

Implemented in Stark::Resources::GlobalItemTemplate, and Stark::Resources::LevelItemTemplate.

ItemVisual * Stark::Resources::ItemTemplate::getSceneInstance (  )  [override, virtual]

Obtain the concrete instance of an item template.

Implements Stark::Resources::Item.

Definition at line 472 of file item.cpp.

void Stark::Resources::ItemTemplate::onAllLoaded (  )  [override, virtual]

Called when the resource sub-tree is entirely loaded.

Allows to load data from other nodes.

Reimplemented from Stark::Resources::Object.

Reimplemented in Stark::Resources::LevelItemTemplate.

Definition at line 440 of file item.cpp.

void Stark::Resources::ItemTemplate::onEnterLocation (  )  [override, virtual]

Called when entering a location.

Reimplemented from Stark::Resources::Object.

Definition at line 1118 of file item.cpp.

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

Persist / restore the resource state.

Called only for active locations

Reimplemented from Stark::Resources::Item.

Definition at line 459 of file item.cpp.

void Stark::Resources::ItemTemplate::setAnimHierarchy ( AnimHierarchy animHierarchy  )  [override, virtual]

Set the currently active anim hierachy.

Implements Stark::Resources::Item.

Definition at line 508 of file item.cpp.

void Stark::Resources::ItemTemplate::setBonesMesh ( int32  index  ) 

Change the item's mesh.

Definition at line 490 of file item.cpp.

void Stark::Resources::ItemTemplate::setInstanciatedItem ( Item instance  ) 

Set the scene instanciation for this template.

Definition at line 468 of file item.cpp.

void Stark::Resources::ItemTemplate::setStockAnimHierachy ( AnimHierarchy animHierarchy  ) 

Define the anim hierarchy to be persisted across locations.

Definition at line 480 of file item.cpp.

void Stark::Resources::ItemTemplate::setTexture ( int32  index,
uint32  textureType 
)

Set the mesh main or face texture.

Definition at line 494 of file item.cpp.


Member Data Documentation

Definition at line 254 of file item.h.

Definition at line 256 of file item.h.

Definition at line 251 of file item.h.

Definition at line 257 of file item.h.

Definition at line 253 of file item.h.

Definition at line 252 of file item.h.


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


Generated on Sat Aug 17 2019 05:03:37 for ResidualVM by doxygen 1.7.1
curved edge   curved edge