就业培训     下载中心     Wiki     联络 登录   注册

---

1. 首页
2. C4D R23.110 C++ SDK

公共成员函数 | 私有成员函数 | 所有成员列表

DescriptionCustomGui Class Reference

#include <customgui_description.h>

Inheritance diagram for DescriptionCustomGui:

[ legend ]

详细描述

Attribute Manager custom GUI ( CUSTOMGUI_DESCRIPTION ).
Here are the settings: DESCRIPTION_CUSTOMGUISETTINGS

公共成员函数
void	SetMaster ( GeDialog *dlg, MasterCallBackFunc *func)
GeData	MasterMessage (const BaseContainer &msg)
void	SetObjectList (const AtomArray &list, Bool limitExceeded=false)
void	SetObject ( C4DAtom *op)
Bool	GetObjectList ( AtomArray &list)
void	SetFilter ( DescriptionFilter *flt)
DescID	HighlightDescID (const DescID &id, Bool check)
void	SetActiveTabPage (const DescID &activetab)
Bool	GetDescIDSelection ( BaseContainer &selection)
String	GetFilterString ( AMFILTERFLAGS &flags)
void	SetFilterString (const maxon::String &filter, AMFILTERFLAGS flags)
void	SetTranslation (const maxon::Delegate < Bool ( GeListNode *node, const DescID &id, DescID &resultId, C4DAtom *&resultAtom)> &func, Bool objectControl=false)
void	ClearTranslation ()
maxon::Result < void >	ModifyDescription ( maxon::Delegate < void( GeListNode *node, 描述 &description, DESCFLAGS_DESC flags)> &&func)
void	ClearModifyDescription ()
Public Member Functions inherited from BaseCustomGui< 1000469 >
Int32	GetWidth ()
Int32	GetHeight ()
void	Redraw ()
Bool	LayoutChanged ()
Bool	激活 ()
Bool	SetDefaultForResEdit ()
Bool	SetData (const TriState < GeData > &tristate)
TriState < GeData >	GetData ()
void	SetLayoutMode ( Int32 mode)
Int32	GetLayoutMode ()
Bool	SupportLayoutSwitch ()
Public Member Functions inherited from _BaseCustomGui
Int32	GetWidth ( Int32 plugid)
Int32	GetHeight ( Int32 plugid)
void	Redraw ( Int32 plugid)
Bool	LayoutChanged ( Int32 plugid)
Bool	激活 ( Int32 plugid)
Bool	SetDefaultForResEdit ( Int32 plugid)
Bool	SetData ( Int32 plugid, const TriState < GeData > &tristate)
TriState < GeData >	GetData ( Int32 plugid)
void	SetLayoutMode ( Int32 plugid, Int32 mode)
Int32	GetLayoutMode ( Int32 plugid)
Bool	SupportLayoutSwitch ( Int32 plugid)

私有成员函数
	DescriptionCustomGui ()
	~DescriptionCustomGui ()

构造函数 & 析构函数文档编制

◆  DescriptionCustomGui()

DescriptionCustomGui () private

◆  ~DescriptionCustomGui()

成员函数文档编制

◆  SetMaster()

Registers the master callback function.

参数

[in]	dlg	The parent dialog. The caller owns the pointed dialog.
[in]	func	The callback function.

◆  MasterMessage()

Sends a master message to the custom GUI.

参数

[in]

msg

The message: MM_HASOBJECTS .

返回

The result.

◆  SetObjectList()

Sets the objects that are shown.

参数

[in]	list	The objects to show.
[in]	limitExceeded	Set to true if if the object count exceeded some limit.

◆  SetObject()

Sets a single objects to show.

参数

[in]

op

The object to show. The caller owns the pointed object.

◆  GetObjectList()

Retrieves the objects that are shown.

参数

[out]

list

Filled with the objects shown.

返回

true if successful, otherwise false .

◆  SetFilter()

Private . Registers a filter callback for the description.

参数

[in]

flt

The callback structure, or nullptr to unregister the filter. The caller owns the pointed structure.

◆  HighlightDescID()

Private .

◆  SetActiveTabPage()

Sets the active description tab.

参数

[in]

activetab

The tab's page description ID.

◆  GetDescIDSelection()

Retrieves the description IDs of the selected description elements.

参数

[out]

selection

Filled with the description IDs of the selected description elements. The container elements' type is CUSTOMDATATYPE_DESCID .

返回

true if successful, otherwise false .

◆  GetFilterString()

Gets the current filter string and flags.

参数

[out]

flags

Assigned the filter flags: AMFILTERFLAGS

返回

The current filter string.

◆  SetFilterString()

Sets the current filter string and flags.

参数

[in]	filter	The filter string.
[in]	flags	The filter flags: AMFILTERFLAGS

◆  SetTranslation()

Sets a lambda function that you can use to translate any DescID within the 描述 via.

参数

[in]	func	The translation lambda function, follows the same signature as C4DAtom::TranslateDescID .
[in]	objectControl	(Optional) True to not translate for GetDEnabling (leave control with the original object).

◆  ClearTranslation()

Clears the function set by SetParentTranslation.

◆  ModifyDescription()

@markprivate Sets a lambda function that you can use to modify the description shown in the attributes manager

参数

[in]

func

The modification function.

返回

OK on success.

◆  ClearModifyDescription()

Clears the function set by ModifyDescription.

• DescriptionCustomGui