Classes
class	GeResource

函数
const String &	GeLoadString ( Int32 id)
String	GeLoadString ( Int32 id, const maxon::String &p1)
String	GeLoadString ( Int32 id, const maxon::String &p1, const maxon::String &p2)
String	GeLoadString ( Int32 id, const maxon::String &p1, const maxon::String &p2, const maxon::String &p3)
String	GeLoadString ( Int32 id, const maxon::String &p1, const maxon::String &p2, const maxon::String &p3, const maxon::String &p4)
Bool	RegisterDescription ( Int32 id, const maxon::String &idstr, LocalResource *res=nullptr)
BaseContainer *	GetMenuResource (const maxon::String &menuname)
Bool	SearchMenuResource ( BaseContainer *bc, const maxon::String &searchstr)
GeData *	SearchPluginMenuResource (const maxon::String &identifier="IDS_EDITOR_PIPELINE"_s)
GeData *	SearchPluginSubMenuResource (const maxon::String &identifier="IDS_EDITOR_PIPELINE"_s, BaseContainer *bc=nullptr)
Filename	GeGetPluginResourcePath ()
void	UpdateMenus (void)
void	FreeResource ()

变量
GeResource	g_resource

Function Documentation

◆  GeLoadString() [1/5]

const String & GeLoadString

(

Int32

id

)

Loads a string from the plugins global resource file.

参数

[in]

id

The ID of the string to get.

返回

The string that matched the passed id .

◆  GeLoadString() [2/5]

String GeLoadString	(	Int32	id ,
		const maxon::String &	p1
	)

Loads a string and replace the '#' with the placeholder string.

注意

在 Cinema 4D there is a convention that in strings '#' is a placeholder for dynamic parts (this allows to translate a whole sentence as sentence structure and word placement may be reverted in other languages).
For example if the string is: "loading of file '#' failed", then the actual filename can be passed as p1 .

参数

[in]	id	The ID of the string to get.
[in]	p1	The string to insert into the placeholder.

返回

The completed string.

◆  GeLoadString() [3/5]

String GeLoadString	(	Int32	id ,
		const maxon::String &	p1 ,
		const maxon::String &	p2
	)

Loads a string and replace the '#' placeholders with the appropriate string.

注意

在 Cinema 4D there is a convention that in strings '#' is a placeholder for dynamic parts (this allows to translate a whole sentence as sentence structure and word placement may be reverted in other languages).
For example if the string is: "loading of file '#' failed", then the actual filename can be passed as p1 .

参数

[in]	id	The ID of the string to get.
[in]	p1	The string to insert into the first placeholder.
[in]	p2	The string to insert into the second placeholder.

返回

The completed string.

◆  GeLoadString() [4/5]

String GeLoadString	(	Int32	id ,
		const maxon::String &	p1 ,
		const maxon::String &	p2 ,
		const maxon::String &	p3
	)

Loads a string and replace the '#' placeholders with the appropriate string.

注意

在 Cinema 4D there is a convention that in strings '#' is a placeholder for dynamic parts (this allows to translate a whole sentence as sentence structure and word placement may be reverted in other languages).
For example if the string is: "loading of file '#' failed", then the actual filename can be passed as p1 .

参数

[in]	id	The ID of the string to get.
[in]	p1	The string to insert into the first placeholder.
[in]	p2	The string to insert into the second placeholder.
[in]	p3	The string to insert into the third placeholder.

返回

The completed string.

◆  GeLoadString() [5/5]

String GeLoadString	(	Int32	id ,
		const maxon::String &	p1 ,
		const maxon::String &	p2 ,
		const maxon::String &	p3 ,
		const maxon::String &	p4
	)

Loads a string and replace the '#' placeholders with the appropriate string.

注意

在 Cinema 4D there is a convention that in strings '#' is a placeholder for dynamic parts (this allows to translate a whole sentence as sentence structure and word placement may be reverted in other languages).
For example if the string is: "loading of file '#' failed", then the actual filename can be passed as p1 .

参数

[in]	id	The ID of the string to get.
[in]	p1	The string to insert into the first placeholder.
[in]	p2	The string to insert into the second placeholder.
[in]	p3	The string to insert into the third placeholder.
[in]	p4	The string to insert into the fourth placeholder.

返回

The completed string.

◆  RegisterDescription()

Bool RegisterDescription	(	Int32	id ,
		const maxon::String &	idstr ,
		LocalResource *	res = nullptr
	)

Registers a description for a plugin ID. This is not needed for plugin types whose Register() functions have a description 参数。

参数

[in]	id	The plugin ID. If this is a standalone description, use a unique ID.
[in]	idstr	The name of the description resource file to use for the plugin without .res extension, for example "registered" . The name has to be unique, i.e. "Tdisplay" cannot be used for 2 different descriptions. See Description Resource for more information.
[in]	res	Pass this to search in a specific resource class. Otherwise the default path is used.

返回

true if the description was registered, otherwise false .

◆  GetMenuResource()

BaseContainer * GetMenuResource

(

const maxon::String &

menuname

)

Gets the menu container of a main menu.

参数

[in]

menuname

The main menu name, e.g. "M_EDITOR" (the same name as on disk or that can be seen in the Menu Editor).

返回

The menu container: MENURESOURCE

◆  SearchMenuResource()

Bool SearchMenuResource	(	BaseContainer *	bc ,
		const maxon::String &	searchstr
	)

Searches a menu container for a certain plugin command (which is a string identifier, for example "PLUGIN_CMD_1000472" ).

参数

[in]	bc	The menu container to search. The caller owns the pointed container.
[in]	searchstr	The search string.

返回

true if the command was found, otherwise false .

◆  SearchPluginMenuResource()

GeData * SearchPluginMenuResource

(

const maxon::String &

identifier = "IDS_EDITOR_PIPELINE"_s

)

Searches for the "Extensions" main menu category in "M_EDITOR" .

参数

[in]

identifier

The menu identifier.

返回

The found menu container, or nullptr . Cinema 4D owns the pointed data.

◆  SearchPluginSubMenuResource()

GeData * SearchPluginSubMenuResource	(	const maxon::String &	identifier = "IDS_EDITOR_PIPELINE"_s ,
		BaseContainer *	bc = nullptr
	)

Searches for the "Extensions" main menu category in "M_EDITOR" or optionally a sub-menu specified by bc .

参数

[in]	identifier	The menu identifier.
[in]	bc	The sub-menu container.

返回

The found menu container, or nullptr . Cinema 4D owns the pointed data.

◆  GeGetPluginResourcePath()

Filename GeGetPluginResourcePath

(

)

Gets a plugin's resource path.

返回

The resource path for the current plugin.

◆  UpdateMenus()

void UpdateMenus

(

void

)

Forces a menu update.

注意

Not necessary when reacting to C4DPL_BUILDMENU .

◆  FreeResource()

void FreeResource

(

)

Private .

Variable Documentation

◆  g_resource

GeResource g_resource

Global resources for Cinema 4D .