Groups | |
ACTIVEOBJECTMANAGER_SETOBJECTS | |
ACTIVEOBJECTMODE | |
AOM_MSG | |
Classes | |
struct | ActiveModeInfo |
Macros | |
#define | LIBRARY_ACTIVEOBJECTMANAGER |
Typedefs | |
typedef GeData | MESSAGEHOOK(const BaseContainer &msg, void *data) |
Variables | |
struct ActiveModeInfo | MAXON_ENUM_LIST |
#define LIBRARY_ACTIVEOBJECTMANAGER |
Active object manager library ID.
typedef GeData MESSAGEHOOK(const BaseContainer &msg, void *data) |
Describes a hook for active object manager modes.
Here is an example:
[in] | msg | The message container. These are the available messages: AOM_MSG |
[in] | data | The data pointer. Depends on the message. |
Bool ActiveObjectManager_RegisterMode | ( | ACTIVEOBJECTMODE | id, |
const String & | text, | ||
MESSAGEHOOK * | hook | ||
) |
Registers a new mode. If no hook is passed the active objects will need to be manually set with ActiveObjectManager_SetObjects().
[in] | id | The mode ID. If it is not a member of ACTIVEOBJECTMODE, use a unique ID: ACTIVEOBJECTMODE |
[in] | text | The mode name. |
[in] | hook | The mode hook, or nullptr to register a mode without a hook. |
void ActiveObjectManager_SetMode | ( | ACTIVEOBJECTMODE | id, |
Bool | openmanager | ||
) |
Sets the current mode.
For example, when the timeline becomes active it calls ( ACTIVEOBJECTMODE::TIMELINE) so that there is a manager ready to show its selections. id The mode ID. openmanager If true a new manager is opened if there is no manager that accepts the given id, for example if the other managers are locked or have that mode disabled.
void ActiveObjectManager_SetObjects | ( | ACTIVEOBJECTMODE | id, |
const AtomArray & | objects, | ||
Int32 | flags, | ||
const DescID & | activepage = DescID() |
||
) |
Sets the currently shown objects in the specified mode id.
[in] | id | The mode ID. |
[in] | objects | The objects to show. |
[in] | flags | The flags: ACTIVEOBJECTMANAGER_SETOBJECTS |
[in] | activepage | The tab of the object's description to be shown. Pass the description ID of the tab. |
void ActiveObjectManager_SetObject | ( | ACTIVEOBJECTMODE | id, |
C4DAtom * | op, | ||
Int32 | flags, | ||
const DescID & | activepage = DescID() |
||
) |
Sets the currently shown object op in the specified mode id.
[in] | id | The mode ID. |
[in] | op | The object to show. |
[in] | flags | The flags: ACTIVEOBJECTMANAGER_SETOBJECTS |
[in] | activepage | The tab of the object's description to be shown. Pass the description ID of the tab. |
void ActiveObjectManager_Open | ( | ) |
Opens a new active object manager.
Shows a modal active object manager dialog with the specified objects and dlgtitle.
[in] | objects | The objects to show. |
[in] | dlgtitle | The dialog title. |
Shows a modal active object manager dialog with the specified object op and title dlgtitle.
[in] | op | The object to show. |
[in] | dlgtitle | The dialog title. |
Shows the edit dialog for a dynamic description (i.e. user data).
Example:
[in] | bl | The owner of the user data e.g. objects, tags etc. |
[in] | id | The ID of the user data element to be inserted. |
void AddDescription | ( | C4DAtom * | bl | ) |
Shows the add dialog for a dynamic description (i.e. user data).
[in] | bl | The owner of the user data e.g. objects, tags etc. The caller owns the pointed C4DAtom. |
void PasteDescription | ( | C4DAtom * | bl | ) |
Shows the paste dialog for a dynamic description (i.e. user data).
[in] | bl | The owner of the user data e.g. objects, tags etc. The caller owns the pointed C4DAtom. |
Bool ActiveObjectManager_GetObjects | ( | ACTIVEOBJECTMODE | id, |
AtomArray & | objects | ||
) |
Retrieves the currently shown objects in the specified mode id.
[in] | id | The mode ID. |
[out] | objects | The shown objects. |
Bool ActiveObjectManager_GetModeInfo | ( | ACTIVEOBJECTMODE | id, |
ActiveModeInfo & | info | ||
) |
Retrieves the information for the specified mode id.
[in] | id | The mode ID. |
[out] | info | Filled with the mode information. |
Int32 ActiveObjectManager_GetModeCount | ( | ) |
Gets the number of modes.
Bool ActiveObjectManager_GetModeInfoIdx | ( | Int32 | idx, |
ActiveModeInfo & | info | ||
) |
Retrieves the information for a mode by index.
[in] | idx | The index of the mode: 0 <= idx < ActiveObjectManager_GetModeCount() |
[out] | info | Filled with the mode information. |
ACTIVEOBJECTMODE ActiveObjectManager_GetLastMode | ( | ) |
Gets the last used mode.
struct ActiveModeInfo MAXON_ENUM_LIST |