Public Types | Public Member Functions | Private Attributes | Friends | List of all members
ArenaElementType Class Reference

#include <arenaelementtype.h>

Public Types

enum  Type { FloorType, WallType, ItemType, MountableItemType }
 

Public Member Functions

 ArenaElementType ()
 
ArenaElementcreateInstance () const
 
QString humanReadableName () const
 Returns the "Name" meta info field if it exists, otherwise name() More...
 
QList< ItemMountPointitemMountPoints () const
 
bool load (const QDir &folderDir)
 
QString mesh () const
 
QVector< QStringPairmetaInfos () const
 
QString name () const
 
QPixmap pixmap () const
 
Type type () const
 

Private Attributes

int m_instanceCount
 
QList< ItemMountPointm_itemMountPoints
 
QString m_mesh
 
QVector< QStringPairm_metaInfos
 
QString m_name
 
QPixmap m_pixmap
 
Type m_type
 

Friends

class ArenaElementTypeRegistry
 

Detailed Description

Definition at line 18 of file arenaelementtype.h.

Member Enumeration Documentation

Enumerator
FloorType 
WallType 
ItemType 

Item freely movable within a grid point.

MountableItemType 

Item that can be mounted to a wall element.

Definition at line 23 of file arenaelementtype.h.

Constructor & Destructor Documentation

ArenaElementType::ArenaElementType ( )

Definition at line 6 of file arenaelementtype.cpp.

Member Function Documentation

ArenaElement * ArenaElementType::createInstance ( ) const

Definition at line 127 of file arenaelementtype.cpp.

QString ArenaElementType::humanReadableName ( ) const

Returns the "Name" meta info field if it exists, otherwise name()

Definition at line 119 of file arenaelementtype.cpp.

QList<ItemMountPoint> ArenaElementType::itemMountPoints ( ) const
inline

Returns a list of item mount points. Currently, this method is only applicable to wall elements

Definition at line 55 of file arenaelementtype.h.

bool ArenaElementType::load ( const QDir &  folderDir)

Loads this element type from the specified folder containing the properties.xml file specific to the type.

Parameters
foldercontaining the properties.xml
Returns
true on success, false if element type could not be loaded from the given folder.

Definition at line 11 of file arenaelementtype.cpp.

QString ArenaElementType::mesh ( ) const
inline

Definition at line 46 of file arenaelementtype.h.

QVector<QStringPair> ArenaElementType::metaInfos ( ) const
inline

Definition at line 48 of file arenaelementtype.h.

QString ArenaElementType::name ( ) const
inline

Definition at line 44 of file arenaelementtype.h.

QPixmap ArenaElementType::pixmap ( ) const
inline

Definition at line 45 of file arenaelementtype.h.

Type ArenaElementType::type ( ) const
inline

Definition at line 47 of file arenaelementtype.h.

Friends And Related Function Documentation

friend class ArenaElementTypeRegistry
friend

Definition at line 20 of file arenaelementtype.h.

Member Data Documentation

int ArenaElementType::m_instanceCount
mutableprivate

Definition at line 64 of file arenaelementtype.h.

QList<ItemMountPoint> ArenaElementType::m_itemMountPoints
private

Definition at line 58 of file arenaelementtype.h.

QString ArenaElementType::m_mesh
private

Definition at line 61 of file arenaelementtype.h.

QVector<QStringPair> ArenaElementType::m_metaInfos
private

Definition at line 59 of file arenaelementtype.h.

QString ArenaElementType::m_name
private

Definition at line 60 of file arenaelementtype.h.

QPixmap ArenaElementType::m_pixmap
private

Definition at line 62 of file arenaelementtype.h.

Type ArenaElementType::m_type
private

Definition at line 63 of file arenaelementtype.h.


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


hector_nist_arena_designer
Author(s): Stefan Kohlbrecher , Johannes Simon
autogenerated on Fri Aug 21 2020 10:45:27