RotationItemCatalog Class Reference

Description

Definition at line 23 of file RotationItemCatalog.h.

Classes
struct	UiInfo

Public Types
using	CatalogedType = RotationItem
enum class	Type : uint8_t {   None = 0 , X = 1 , Y = 2 , Z = 3 ,   Euler = 4 }

Static Public Member Functions
static RotationItem *	create (Type type)
	Creates the item of the given type. More...
static Type	type (const RotationItem *item)
	Returns the enum type of the given item. More...
static QVector< Type >	types ()
	Available types of interference items. More...
static UiInfo	uiInfo (Type t)
	UiInfo on the given type. More...

Member Typedef Documentation

CatalogedType

using RotationItemCatalog::CatalogedType = RotationItem

Definition at line 25 of file RotationItemCatalog.h.

Member Enumeration Documentation

Type

enum RotationItemCatalog::Type : uint8_t

strong

Enumerator
None
X
Y
Z
Euler

Definition at line 28 of file RotationItemCatalog.h.

                    : uint8_t {
        None = 0,
        X = 1,
        Y = 2,
        Z = 3,
        Euler = 4,
    };

Member Function Documentation

create()

RotationItem * RotationItemCatalog::create ( Type  type )

static

Creates the item of the given type.

If type is "None", a nullptr is returned.

Definition at line 19 of file RotationItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return nullptr;
    case Type::X:
        return new XRotationItem();
    case Type::Y:
        return new YRotationItem();
    case Type::Z:
        return new ZRotationItem();
    case Type::Euler:
        return new EulerRotationItem();
    }
    ASSERT(false);
}

References Euler, None, type(), X, Y, and Z.

Here is the call graph for this function:

type()

RotationItemCatalog::Type RotationItemCatalog::type ( const RotationItem *  item )

static

Returns the enum type of the given item.

Definition at line 59 of file RotationItemCatalog.cpp.

{
    if (!item)
        return Type::None;
 
    if (dynamic_cast<const XRotationItem*>(item))
        return Type::X;
    if (dynamic_cast<const YRotationItem*>(item))
        return Type::Y;
    if (dynamic_cast<const ZRotationItem*>(item))
        return Type::Z;
    if (dynamic_cast<const EulerRotationItem*>(item))
        return Type::Euler;
 
    ASSERT(false);
}

References Euler, None, X, Y, and Z.

Referenced by create(), and uiInfo().

types()

QVector< RotationItemCatalog::Type > RotationItemCatalog::types ( )

static

Available types of interference items.

Contains also type "None". This list is sorted as expected in the UI (e.g. in combo box)

Definition at line 36 of file RotationItemCatalog.cpp.

{
    return {Type::None, Type::X, Type::Y, Type::Z, Type::Euler};
}

References Euler, None, X, Y, and Z.

uiInfo()

RotationItemCatalog::UiInfo RotationItemCatalog::uiInfo ( Type  t )

static

UiInfo on the given type.

Definition at line 41 of file RotationItemCatalog.cpp.

{
    switch (type) {
    case Type::None:
        return {"None", "", ""};
    case Type::X:
        return {"X axis Rotation", "Particle rotation around x-axis", ""};
    case Type::Y:
        return {"Y axis Rotation", "Particle rotation around y-axis", ""};
    case Type::Z:
        return {"Z axis Rotation", "Particle rotation around z-axis", ""};
    case Type::Euler:
        return {"Euler Rotation",
                "Sequence of three rotations following Euler angles; notation z-x'-z'", ""};
    }
    ASSERT(false);
}

References Euler, None, type(), X, Y, and Z.

Here is the call graph for this function:

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatSample/RotationItemCatalog.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/CatSample/RotationItemCatalog.cpp