DataDescriptionDatabaseInterface Class Reference | C4D R23.110 C++ SDK - 中文文档编制,帮助,手册,教程

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

DataDescriptionDatabaseInterface Class Reference

#include <datadescriptiondatabase.h>

详细描述

Interface to access the storage of DataDescription objects.

静态公共成员函数
static MAXON_METHOD Result < DataDescription >	LoadDescription (const Id &category, const LanguageRef &language, const Id &dataType)
static MAXON_METHOD Result < DataDescription >	LoadDescription (const Id &category, const LanguageRef &language, const IdAndVersion &dataType)
static MAXON_METHOD Result < void >	StoreDescription (const Id &category, const LanguageRef &language, const Id &dataType, DataDescription &description)
static MAXON_METHOD Result < void >	StoreDescription (const Id &category, const LanguageRef &language, const IdAndVersion &dataType, DataDescription &description)
static MAXON_METHOD Result < void >	DescriptionDefinitionChanged (const Id &category, const LanguageRef &language, const IdAndVersion &dataType)
static MAXON_METHOD Result < BaseArray < Tuple < Id , 数据 , String > > >	GetEffectiveEnumList (const DataDictionary &dataEntry, const DataDictionary &guiEntry, const DataDescription &stringDescription, Bool resolveExtensionPointsAndGui, const AssetRepositoryRef &repository, const 数据 *filterData)
static MAXON_METHOD Result < BaseArray < Tuple < Id , 数据 , String > > >	GetEffectiveEnumList (const DataDictionary &dataEntry, const DataDictionary &guiEntry, const DataDescription &stringDescription, Bool resolveExtensionPointsAndGui, Bool withStrings, const LanguageRef &language, const AssetRepositoryRef &repository, const 数据 *filterData)
static MAXON_METHOD Result < void >	PostProcessStringDescription (DataDescription &description, const BaseArray < DataDictionary > &entries)

私有成员函数
	MAXON_INTERFACE_NONVIRTUAL ( DataDescriptionDatabaseInterface , MAXON_REFERENCE_NONE , "net.maxon.interface.datadescriptiondatabase")

成员函数文档编制

◆ MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL	(	DataDescriptionDatabaseInterface	,
		MAXON_REFERENCE_NONE	,
		"net.maxon.interface.datadescriptiondatabase"
	)

private

◆ LoadDescription() [1/2]

static MAXON_METHOD Result <DataDescription> LoadDescription	(	const Id &	category ,
		const LanguageRef &	language ,
		const Id &	dataType
	)

static

LoadDescription description.

参数

[in]	category	Database category (e.g. DATADESCRIPTION_CATEGORY_DATA / DATADESCRIPTION_CATEGORY_UI).
[in]	language	Language (only valid for category DATADESCRIPTION_CATEGORY_STRING).
[in]	dataType	数据 type id to load.

返回: OK on success.

◆ LoadDescription() [2/2]

static MAXON_METHOD Result <DataDescription> LoadDescription	(	const Id &	category ,
		const LanguageRef &	language ,
		const IdAndVersion &	dataType
	)

static

◆ StoreDescription() [1/2]

static MAXON_METHOD Result <void> StoreDescription	(	const Id &	category ,
		const LanguageRef &	language ,
		const Id &	dataType ,
		DataDescription &	description
	)

static

StoreDescription description.

参数

[in]	category	Database category (e.g. DATADESCRIPTION_CATEGORY_DATA / DATADESCRIPTION_CATEGORY_UI).
[in]	language	Language (only valid for category DATADESCRIPTION_CATEGORY_STRING).
[in]	dataType	数据 type id to store.
[in]	description	描述 data to store.

返回: OK on success.

◆ StoreDescription() [2/2]

static MAXON_METHOD Result <void> StoreDescription	(	const Id &	category ,
		const LanguageRef &	language ,
		const IdAndVersion &	dataType ,
		DataDescription &	description
	)

static

◆ DescriptionDefinitionChanged()

static MAXON_METHOD Result <void> DescriptionDefinitionChanged	(	const Id &	category ,
		const LanguageRef &	language ,
		const IdAndVersion &	dataType
	)

static

Resets the cached description.

◆ GetEffectiveEnumList() [1/2]

static MAXON_METHOD Result < BaseArray < Tuple < Id , 数据 , String > > > GetEffectiveEnumList	(	const DataDictionary &	dataEntry ,
		const DataDictionary &	guiEntry ,
		const DataDescription &	stringDescription ,
		Bool	resolveExtensionPointsAndGui ,
		const AssetRepositoryRef &	repository ,
		const 数据 *	filterData
	)

static

◆ GetEffectiveEnumList() [2/2]

static MAXON_METHOD Result < BaseArray < Tuple < Id , 数据 , String > > > GetEffectiveEnumList	(	const DataDictionary &	dataEntry ,
		const DataDictionary &	guiEntry ,
		const DataDescription &	stringDescription ,
		Bool	resolveExtensionPointsAndGui ,
		Bool	withStrings ,
		const LanguageRef &	language ,
		const AssetRepositoryRef &	repository ,
		const 数据 *	filterData
	)

static

GetEffectiveEnumList returns the enum list prepared for display in the ui with the user order etc. It takes DESCRIPTION::DATA::BASE::ENUM and DESCRIPTION::UI::BASE::ENUM into account.

参数

[in]	dataEntry	描述 of the data.
[in]	guiEntry	描述 of the ui.
[in]	stringDescription	描述 of the strings.
[in]	resolveExtensionPointsAndGui	True if extension points and ui order should be evaluated. False will return the unprocessed DESCRIPTION::DATA::BASE::ENUM array.
[in]	withStrings	True if strings shall be set up.
[in]	language	Language to use.
[in]	repository	Asset Repository to use.
[in]	filterData	Filter only for this one type. Nullptr to disable filtering.

返回: OK on success.

◆ PostProcessStringDescription()

static MAXON_METHOD Result <void> PostProcessStringDescription	(	DataDescription &	description ,
		const BaseArray < DataDictionary > &	entries
	)

static

PostProcessStringDescription description.

参数

[in]	description	描述 to modify
[in]	entries	String description entries to process.

返回: OK on success.