Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
DataTypes.hh File Reference
#include <OpenFlipper/common/GlobalDefines.hh>
#include <ACG/Math/Matrix4x4T.hh>
#include <ACG/Math/VectorT.hh>
#include <climits>
#include <QIcon>
#include <QMetaType>

Go to the source code of this file.

Classes

class  DataType
 Predefined datatypes. More...
 
class  TypeInfo
 

Typedefs

typedef ACG::Vec3d Vector
 Standard Type for 3d Vector used for scripting.
 
typedef ACG::Vec4d Vector4
 Standard Type for 4d Vector used for scripting.
 
typedef std::vector< int > IdList
 Standard Type for id Lists used for scripting.
 
typedef ACG::Matrix4x4d Matrix4x4
 Standard Type for a 4x4 Matrix used for scripting.
 

Functions

std::ostream & operator<< (std::ostream &stream, DataType type)
 
Functions for adding dataTypes
DLLEXPORT DataType addDataType (QString _name, QString _readableName)
 Adds a datatype and returns the id for the new type. More...
 
DLLEXPORT DataType typeId (QString _name)
 Given a dataType Identifier string this function will return the id of the datatype. More...
 
DLLEXPORT QString typeName (DataType _id)
 Get the name of a type with given id. More...
 
DLLEXPORT bool typeExists (QString _name)
 Check if a type with the given name exists. More...
 
DLLEXPORT size_t typeCount ()
 Get the number of registered types. More...
 
Type iterators
DLLEXPORT std::vector
< TypeInfo >::const_iterator 
typesBegin ()
 Get iterator pointing to the first element in the types list. More...
 
DLLEXPORT std::vector
< TypeInfo >::const_iterator 
typesEnd ()
 Get iterator pointing to the last element in the types list. More...
 
Datatype Name handling
DLLEXPORT QString dataTypeName (DataType _id)
 Get DataType Human readable name ( this name might change. Use the typeName instead! ) More...
 
DLLEXPORT QString dataTypeName (QString _typeName)
 Get DataType Human readable name ( this name might change. Use the typeName instead! ) More...
 
DLLEXPORT void setDataTypeName (DataType _id, QString _name)
 Set DataType Human readable name. More...
 
DLLEXPORT void setDataTypeName (QString _typeName, QString _name)
 Set DataType Human readable name. More...
 
Datatype Icons
DLLEXPORT QString typeIconName (QString _name)
 Get a string with the filename of the icon for the DataType name. More...
 
DLLEXPORT QString typeIconName (DataType _id)
 Get a string with the filename of the icon for the DataType. More...
 
DLLEXPORT QIcon & typeIcon (DataType _id)
 Get an QIcon associated with the given DataType. More...
 
DLLEXPORT void setTypeIcon (DataType _id, QString _icon)
 Set an Icon for a given DataType. More...
 
DLLEXPORT void setTypeIcon (QString _name, QString _icon)
 Set an Icon for a given DataType. More...
 

Variables

const DataType DATA_ALL (UINT_MAX)
 Identifier for all available objects.
 
const DataType DATA_UNKNOWN (0)
 None of the other Objects.
 
const DataType DATA_GROUP (1)
 Items used for Grouping.
 

Detailed Description

This File contains the basic type informations

Definition in file DataTypes.hh.

Function Documentation

DLLEXPORT DataType addDataType ( QString  _name,
QString  _readableName 
)

Adds a datatype and returns the id for the new type.

Adds a datatype and returns the id for the new type

Parameters
_nameInternal name for the new DataType
_readableNameHuman readable Name for this type ( Use tr to make it translatable )

Definition at line 120 of file Types.cc.

DLLEXPORT QString dataTypeName ( DataType  _id)

Get DataType Human readable name ( this name might change. Use the typeName instead! )

Get DataType Human readable name ( this name might change. Use the typeName instead! )

Definition at line 255 of file Types.cc.

DLLEXPORT QString dataTypeName ( QString  _typeName)

Get DataType Human readable name ( this name might change. Use the typeName instead! )

Get DataType Human readable name ( this name might change. Use the typeName instead! )

Definition at line 268 of file Types.cc.

DLLEXPORT void setDataTypeName ( DataType  _id,
QString  _name 
)

Set DataType Human readable name.

Set DataType Human readable name.

Definition at line 283 of file Types.cc.

DLLEXPORT void setDataTypeName ( QString  _typeName,
QString  _name 
)

Set DataType Human readable name.

Set DataType Human readable name.

Definition at line 294 of file Types.cc.

DLLEXPORT void setTypeIcon ( DataType  _id,
QString  _icon 
)

Set an Icon for a given DataType.

Set an Icon for a given DataType.

Definition at line 226 of file Types.cc.

DLLEXPORT void setTypeIcon ( QString  _name,
QString  _icon 
)

Set an Icon for a given DataType.

Set an Icon for a given DataType.

Definition at line 240 of file Types.cc.

DLLEXPORT size_t typeCount ( )

Get the number of registered types.

This function will return the number of types registered to the core. You can use it to iterate over all types.

Note
Remember that the types are organized in a bitfield!

Get the number of registered types.

Definition at line 178 of file Types.cc.

DLLEXPORT bool typeExists ( QString  _name)

Check if a type with the given name exists.

Definition at line 172 of file Types.cc.

DLLEXPORT QIcon& typeIcon ( DataType  _id)

Get an QIcon associated with the given DataType.

The icons are loaded once when set and then the reference is returned here. This reduces the time when frequently requesting the icons (e.g. DataControl)

Get an QIcon associated with the given DataType.

Definition at line 215 of file Types.cc.

DLLEXPORT QString typeIconName ( QString  _name)

Get a string with the filename of the icon for the DataType name.

Get a string with the filename of the icon for the DataType name.

Definition at line 193 of file Types.cc.

DLLEXPORT QString typeIconName ( DataType  _id)

Get a string with the filename of the icon for the DataType.

Get a string with the filename of the icon for the DataType.

Definition at line 204 of file Types.cc.

DLLEXPORT DataType typeId ( QString  _name)

Given a dataType Identifier string this function will return the id of the datatype.

Given a dataType Identifier string this function will return the id of the datatype.

Definition at line 142 of file Types.cc.

DLLEXPORT QString typeName ( DataType  _id)

Get the name of a type with given id.

The ids are organized in a bitfield. So use either the macro for getting the type id or use the id directly (they have to be power of 2! ... Bitfield)

Definition at line 157 of file Types.cc.

DLLEXPORT std::vector< TypeInfo >::const_iterator typesBegin ( )

Get iterator pointing to the first element in the types list.

Get iterator pointing to the first element in the types list.

Definition at line 183 of file Types.cc.

DLLEXPORT std::vector< TypeInfo >::const_iterator typesEnd ( )

Get iterator pointing to the last element in the types list.

Get iterator pointing to the last element in the types list.

Definition at line 188 of file Types.cc.