|
Bool | ActiveObjectManager_RegisterMode (ACTIVEOBJECTMODE id, const String &text, MESSAGEHOOK *hook) |
|
void | ActiveObjectManager_SetMode (ACTIVEOBJECTMODE id, Bool openmanager) |
|
void | ActiveObjectManager_SetObjects (ACTIVEOBJECTMODE id, const AtomArray &objects, Int32 flags, const DescID &activepage=DescID()) |
|
void | ActiveObjectManager_SetObject (ACTIVEOBJECTMODE id, C4DAtom *op, Int32 flags, const DescID &activepage=DescID()) |
|
void | ActiveObjectManager_Open () |
|
Bool | EditObjectModal (const AtomArray &objects, const String &dlgtitle) |
|
Bool | EditObjectModal (C4DAtom *op, const String &dlgtitle) |
|
Bool | EditDescription (C4DAtom *bl, const DescID &id) |
|
void | AddDescription (C4DAtom *bl) |
|
void | PasteDescription (C4DAtom *bl) |
|
Bool | ActiveObjectManager_GetObjects (ACTIVEOBJECTMODE id, AtomArray &objects) |
|
Bool | ActiveObjectManager_GetModeInfo (ACTIVEOBJECTMODE id, ActiveModeInfo &info) |
|
Int32 | ActiveObjectManager_GetModeCount () |
|
Bool | ActiveObjectManager_GetModeInfoIdx (Int32 idx, ActiveModeInfo &info) |
|
ACTIVEOBJECTMODE | ActiveObjectManager_GetLastMode () |
|
◆ LIBRARY_ACTIVEOBJECTMANAGER
#define LIBRARY_ACTIVEOBJECTMANAGER |
Active object manager library ID.
◆ MESSAGEHOOK
Describes a hook for active object manager modes.
Here is an example:
{
{
return true;
{
if (!doc)
break;
return true;
}
break;
}
return false;
}
- Parameters
-
[in] | msg | The message container. These are the available messages: AOM_MSG |
[in] | data | The data pointer. Depends on the message. |
- Returns
- true if successful, otherwise false.
◆ ActiveObjectManager_RegisterMode()
Registers a new mode. If no hook is passed the active objects will need to be manually set with ActiveObjectManager_SetObjects().
- Parameters
-
[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. |
- Returns
- true if the new mode was registered, otherwise false.
◆ ActiveObjectManager_SetMode()
Sets the current mode.
For example, when the timeline becomes active it calls ActiveObjectManager_SetMode(ACTIVEOBJECTMODE::TIMELINE) so that there is a manager ready to show its selections.
- Parameters
-
[in] | id | The mode ID. |
[in] | 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. |
◆ ActiveObjectManager_SetObjects()
Sets the currently shown objects in the specified mode id.
- Note
- Use this only if a mode has been registered without a hook. Otherwise the managers will ask for new objects themselves, and listen for events when new objects are selected.
- Parameters
-
[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. |
◆ ActiveObjectManager_SetObject()
Sets the currently shown object op in the specified mode id.
- Note
- Use this only if a mode has been registered without a hook. Otherwise the managers will ask for new objects themselves, and listen for events when new objects are selected.
- Parameters
-
[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. |
◆ ActiveObjectManager_Open()
void ActiveObjectManager_Open |
( |
| ) |
|
Opens a new active object manager.
◆ EditObjectModal() [1/2]
Shows a modal active object manager dialog with the specified objects and dlgtitle.
- Parameters
-
[in] | objects | The objects to show. |
[in] | dlgtitle | The dialog title. |
- Returns
- true if successful, otherwise false.
◆ EditObjectModal() [2/2]
Shows a modal active object manager dialog with the specified object op and title dlgtitle.
- Parameters
-
[in] | op | The object to show. |
[in] | dlgtitle | The dialog title. |
- Returns
- true if successful, otherwise false.
◆ EditDescription()
Shows the edit dialog for a dynamic description (i.e. user data).
Example:
- Parameters
-
[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. |
- Returns
- true if successful, otherwise false.
◆ AddDescription()
void AddDescription |
( |
C4DAtom * |
bl | ) |
|
Shows the add dialog for a dynamic description (i.e. user data).
- Since
- R17.032
- Parameters
-
[in] | bl | The owner of the user data e.g. objects, tags etc. The caller owns the pointed C4DAtom. |
◆ PasteDescription()
void PasteDescription |
( |
C4DAtom * |
bl | ) |
|
Shows the paste dialog for a dynamic description (i.e. user data).
- Since
- R17.032
- Parameters
-
[in] | bl | The owner of the user data e.g. objects, tags etc. The caller owns the pointed C4DAtom. |
◆ ActiveObjectManager_GetObjects()
Retrieves the currently shown objects in the specified mode id.
- Parameters
-
[in] | id | The mode ID. |
[out] | objects | The shown objects. |
- Returns
- true if successful, otherwise false.
◆ ActiveObjectManager_GetModeInfo()
Retrieves the information for the specified mode id.
- Parameters
-
[in] | id | The mode ID. |
[out] | info | Filled with the mode information. |
- Returns
- true if successful, otherwise false.
◆ ActiveObjectManager_GetModeCount()
Int32 ActiveObjectManager_GetModeCount |
( |
| ) |
|
Gets the number of modes.
- Returns
- The number of modes.
◆ ActiveObjectManager_GetModeInfoIdx()
Retrieves the information for a mode by index.
- Parameters
-
- Returns
- true if successful, otherwise false.
◆ ActiveObjectManager_GetLastMode()
Gets the last used mode.
- Returns
- The last mode.
◆ MAXON_ENUM_LIST
DynamicDescription * GetDynamicDescription()
BaseContainer GetCustomDataTypeDefault(Int32 type)
Bool EditDescription(C4DAtom *bl, const DescID &id)
BaseDocument * GetActiveDocument(void)
@ DESC_ANIMATE
Int32 Animation mode:
Definition: lib_description.h:104
void SetInt32(Int32 id, Int32 l)
Definition: c4d_basecontainer.h:505
#define AOM_MSG_GETATOMLIST
Sent when the active Object Manager needs a list of atoms to show. Store these in the AtomArray* poin...
Definition: lib_activeobjectmanager.h:102
void SetString(Int32 id, const maxon::String &s)
Definition: c4d_basecontainer.h:569
#define AOM_MSG_ISENABLED
Sent when the mode is enabled.
Definition: lib_activeobjectmanager.h:101
void SetBool(Int32 id, Bool b)
Definition: c4d_basecontainer.h:498
@ DESC_MIN
Int32/Float/Vector Minimum value.
Definition: lib_description.h:99
Int32 GetId() const
Definition: c4d_basecontainer.h:131
void GetActiveTags(AtomArray &selection) const
@ DESC_SHORT_NAME
String Short name, for attributes dialog.
Definition: lib_description.h:92
@ DESC_MAX
Int32/Float/Vector Maximum value.
Definition: lib_description.h:100
@ DTYPE_LONG
Int32
Definition: lib_description.h:67
Definition: c4d_gedata.h:82
@ DESC_CUSTOMGUI
Int32 The ID of the GUI for this element. Either a custom ID or one of: CUSTOMGUI
Definition: lib_description.h:125
@ DESC_ANIMATE_ON
Parameter is animatable.
Definition: lib_description.h:106
@ DESC_NAME
String Name for standalone use.
Definition: lib_description.h:91
@ DESC_REMOVEABLE
Bool true if entry is removable.
Definition: lib_description.h:129
Definition: c4d_baselist.h:1587
@ DESC_STEP
Int32/Float/Vector The step for the edit field arrows.
Definition: lib_description.h:103
Definition: lib_description.h:733
#define CUSTOMGUI_LONG
Int32 edit field.
Definition: lib_description.h:210
DescID Alloc(const BaseContainer &datadescription)
Definition: c4d_basedocument.h:490
Definition: c4d_basecontainer.h:46