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

#include <path.h>

Inheritance diagram for Stark::Resources::Path3D:
Stark::Resources::Path Stark::Resources::Object

Classes

struct  Vertex
 

Public Member Functions

 Path3D (Object *parent, byte subType, uint16 index, const Common::String &name)
 
void readData (Formats::XRCReadStream *stream) override
 
uint getEdgeCount () const override
 
float getSortKey () const override
 
Math::Vector3d getEdgeDirection (uint edgeIndex) const override
 
Math::Vector3d getVertexPosition3D (uint vertexIndex, int32 *faceIndex)
 
- Public Member Functions inherited from Stark::Resources::Path
 Path (Object *parent, byte subType, uint16 index, const Common::String &name)
 
float getWeightedEdgeLength (uint edgeIndex) const
 
Math::Vector3d getWeightedPositionInEdge (uint edgeIndex, float positionInEdge)
 
- 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 ()
 
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

float getVertexWeight (uint vertexIndex) const override
 
Math::Vector3d getVertexPosition (uint vertexIndex) const override
 
- Protected Member Functions inherited from Stark::Resources::Path
float getEdgeLength (uint edgeIndex) const
 
- 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
 

Additional Inherited Members

- Public Types inherited from Stark::Resources::Path
enum  SubType { kPath2D = 1, kPath3D = 2 }
 
- Static Public Member Functions inherited from Stark::Resources::Path
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::Path
static const Type::ResourceType TYPE = Type::kPath
 
- Protected Attributes inherited from Stark::Resources::Path
uint32 _field_30
 
- 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 3D path for 3D items

Member Function Documentation

◆ readData()

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

Deserialize the resource static data and initial state.

Reimplemented from Stark::Resources::Path.

◆ getEdgeCount()

uint Stark::Resources::Path3D::getEdgeCount ( ) const
overridevirtual

Get the edge count in the path

Implements Stark::Resources::Path.

◆ getSortKey()

float Stark::Resources::Path3D::getSortKey ( ) const
overridevirtual

Get the sort key to be used by the item following the path

Reimplemented from Stark::Resources::Path.

◆ getEdgeDirection()

Math::Vector3d Stark::Resources::Path3D::getEdgeDirection ( uint  edgeIndex) const
overridevirtual

Get a unit vector pointing in the direction of an edge

Only valid for 3D paths

Reimplemented from Stark::Resources::Path.

◆ getVertexPosition3D()

Math::Vector3d Stark::Resources::Path3D::getVertexPosition3D ( uint  vertexIndex,
int32 *  faceIndex 
)

Get the full position in world coordinates of one of the vertices of the path

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