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

Stark::Resources::FloorPositionedItem Class Reference

3D positioned item More...

#include <item.h>

Inheritance diagram for Stark::Resources::FloorPositionedItem:
Collaboration diagram for Stark::Resources::FloorPositionedItem:

List of all members.

Public Member Functions

 FloorPositionedItem (Object *parent, byte subType, uint16 index, const Common::String &name)
virtual ~FloorPositionedItem ()
void saveLoad (ResourceSerializer *serializer) override
 Persist / restore the resource state.
void placeOnBookmark (Bookmark *target)
 Move the item to a bookmarked position.
void placeDefaultPosition ()
 Place the item on the center of the first floor face.
Math::Vector3d getPosition3D () const
 Get the item position.
void setPosition3D (const Math::Vector3d &position)
 Move the item.
int32 getFloorFaceIndex () const
 Get the floor face index the item is standing on.
void setFloorFaceIndex (int32 faceIndex)
 Change the face the item is standing on.
Math::Vector3d getDirectionVector () const
 Get a vector pointing in the same direction as the item.
void setDirection (const Math::Angle &direction)
 Set the direction the item faces.
float getSortKey () const
 Obtain the sort value for the item, used to compute the draw order.
void overrideSortKey (float sortKey)
 Don't rely on the floor face to compute the sort key, use the provided value instead.

Protected Attributes

int32 _floorFaceIndex
Math::Vector3d _position3D
float _direction3D
bool _sortKeyOverride
float _sortKeyOverridenValue

Detailed Description

3D positioned item

Items with a 3D position, used in 3D layers. The sort key determines the order in which such items are drawn in.

Definition at line 334 of file item.h.


Constructor & Destructor Documentation

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

Definition at line 713 of file item.cpp.

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

Definition at line 710 of file item.cpp.


Member Function Documentation

Math::Vector3d Stark::Resources::FloorPositionedItem::getDirectionVector (  )  const

Get a vector pointing in the same direction as the item.

Definition at line 765 of file item.cpp.

int32 Stark::Resources::FloorPositionedItem::getFloorFaceIndex (  )  const

Get the floor face index the item is standing on.

Definition at line 729 of file item.cpp.

Math::Vector3d Stark::Resources::FloorPositionedItem::getPosition3D (  )  const

Get the item position.

Definition at line 721 of file item.cpp.

float Stark::Resources::FloorPositionedItem::getSortKey (  )  const

Obtain the sort value for the item, used to compute the draw order.

Definition at line 784 of file item.cpp.

void Stark::Resources::FloorPositionedItem::overrideSortKey ( float  sortKey  ) 

Don't rely on the floor face to compute the sort key, use the provided value instead.

This can be used to handle cases where the item is not over the floor.

Definition at line 779 of file item.cpp.

void Stark::Resources::FloorPositionedItem::placeDefaultPosition (  ) 

Place the item on the center of the first floor face.

Definition at line 752 of file item.cpp.

void Stark::Resources::FloorPositionedItem::placeOnBookmark ( Bookmark target  ) 

Move the item to a bookmarked position.

Definition at line 738 of file item.cpp.

void Stark::Resources::FloorPositionedItem::saveLoad ( ResourceSerializer serializer  )  [override, virtual]

Persist / restore the resource state.

Reimplemented from Stark::Resources::ItemVisual.

Definition at line 799 of file item.cpp.

void Stark::Resources::FloorPositionedItem::setDirection ( const Math::Angle direction  ) 

Set the direction the item faces.

Definition at line 775 of file item.cpp.

void Stark::Resources::FloorPositionedItem::setFloorFaceIndex ( int32  faceIndex  ) 

Change the face the item is standing on.

Definition at line 733 of file item.cpp.

void Stark::Resources::FloorPositionedItem::setPosition3D ( const Math::Vector3d position  ) 

Move the item.

Definition at line 725 of file item.cpp.


Member Data Documentation

Definition at line 377 of file item.h.

Definition at line 379 of file item.h.

Definition at line 380 of file item.h.


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


Generated on Sat May 18 2019 05:07:32 for ResidualVM by doxygen 1.7.1
curved edge   curved edge