就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. C4D R23.110 C++ SDK
公共成员函数 | 静态公共成员函数 | 私有成员函数 | 所有成员列表

DataDescriptionDefinitionInterface Class Reference

#include <datadescriptiondefinition.h>

Inheritance diagram for DataDescriptionDefinitionInterface:
Inheritance graph
[ legend ]

详细描述

Interface to store descriptions definitions of objects. The DataDescription definition defines a sequence of "commands" to define attributes, include, commands, strings, etc.

公共成员函数

MAXON_METHOD DataDictionary  GetInfo () const
MAXON_METHOD Result < void >  SetInfo (const DataDictionary &info)
MAXON_METHOD Int   GetEntryCount () const
MAXON_METHOD Result < BaseArray < DataDescriptionEntry > >  GetEntries () const
MAXON_METHOD Result < DataDescriptionEntry >  GetEntry ( Int idx) const
MAXON_METHOD Result < DataDescriptionEntry >  FindEntry (const InternedId &id) const
MAXON_METHOD Result < Int >  AddEntry (const DataDescriptionEntry &props)
MAXON_METHOD Result < void >  ReplaceEntry (const DataDescriptionEntry &props)
MAXON_METHOD Result < Bool >  ReplaceEntry ( Int idx, const DataDescriptionEntry &props)
MAXON_METHOD Result < void >  EraseEntry ( Int idx)
MAXON_METHOD void  重置 ()

静态公共成员函数

static MAXON_METHOD Result < void >  MergeDescriptionDefinition (DataDescriptionDefinition &target, const DataDescriptionDefinition &source, Bool overwriteIncludes, Bool skipIncludes)
static MAXON_METHOD Result < 数据 >  GetDataDefaults (const DataDictionary &dataEntry)
static MAXON_METHOD Result < 数据 >  GetDataValueOrDefaults (const InternedId &dataId, const DataDictionary &dataEntry, GETDATAFLAGS flags, const GetDataCallbackType &getDataCallback)
static MAXON_METHOD DataDescriptionDefinitionInterface *  创建 ()
static const MAXON_METHOD DataDescriptionDefinitionInterface *  NullValuePtr ()

私有成员函数

  MAXON_INTERFACE ( DataDescriptionDefinitionInterface , MAXON_REFERENCE_COPY_ON_WRITE , "net.maxon.interface.datadescriptiondefinition")

成员函数文档编制

◆  MAXON_INTERFACE()

MAXON_INTERFACE ( DataDescriptionDefinitionInterface   ,
MAXON_REFERENCE_COPY_ON_WRITE   ,
"net.maxon.interface.datadescriptiondefinition"   
)
private

◆  GetInfo()

MAXON_METHOD DataDictionary GetInfo ( ) const

Returns the info dictionary.

◆  SetInfo()

MAXON_METHOD Result <void> SetInfo ( const DataDictionary &  info )

SetInfo the info dictionary of the description.

参数
[in] info Dictionary with infos.
返回
OK on success.

◆  GetEntryCount()

MAXON_METHOD Int GetEntryCount ( ) const

Returns the number of entries in the description.

◆  GetEntries()

MAXON_METHOD Result < BaseArray < DataDescriptionEntry > > GetEntries ( ) const

Returns a array with all entries.

◆  GetEntry()

MAXON_METHOD Result < DataDescriptionEntry > GetEntry ( Int   idx ) const

Returns a specific entry with the given index.

参数
[in] idx Index to return.
返回
Entry on success.

◆  FindEntry()

MAXON_METHOD Result < DataDescriptionEntry > FindEntry ( const InternedId &  id ) const

FindEntry searches the first occurrence of the entry.

参数
[in] id Id to search.
返回
Entry on success.

◆  AddEntry()

MAXON_METHOD Result < Int > AddEntry ( const DataDescriptionEntry &  props )

AddEntry to the description.

参数
[in] props Attribute to add to the end of the list.
返回
Index of the new attribute on success.

◆  ReplaceEntry() [1/2]

MAXON_METHOD Result <void> ReplaceEntry ( const DataDescriptionEntry &  props )

Replaces an entry.

参数
[in] props Properties to replace.
返回
OK on success.

◆  ReplaceEntry() [2/2]

MAXON_METHOD Result < Bool > ReplaceEntry ( Int   idx ,
const DataDescriptionEntry &  props  
)

Replaces an entry.

参数
[in] idx Index to replace.
[in] props Properties to replace.
返回
True if changes were detected. False if the data was identical.

◆  EraseEntry()

MAXON_METHOD Result <void> EraseEntry ( Int   idx )

EraseEntry an attribute from the description.

参数
[in] idx Index of the attribute to delete.
返回
OK on success.

◆  Reset()

MAXON_METHOD void Reset ( )

Resets the description and clear all attributes.

◆  MergeDescriptionDefinition()

static MAXON_METHOD Result <void> MergeDescriptionDefinition ( DataDescriptionDefinition &  target ,
const DataDescriptionDefinition &  source ,
Bool   overwriteIncludes ,
Bool   skipIncludes  
)
static

Merges the given descriptions.

参数
[in] target Target description to overwrite.
[in] source New entries to merge into target.
[in] overwriteIncludes True to overwrite the includes of target id source has includes.
返回
OK on success.

◆  GetDataDefaults()

static MAXON_METHOD Result < 数据 > GetDataDefaults ( const DataDictionary &  dataEntry )
static

◆  GetDataValueOrDefaults()

static MAXON_METHOD Result < 数据 > GetDataValueOrDefaults ( const InternedId &  dataId ,
const DataDictionary &  dataEntry ,
GETDATAFLAGS   flags ,
const GetDataCallbackType &  getDataCallback  
)
static

◆  Create()

static MAXON_METHOD DataDescriptionDefinitionInterface * Create ( )
static

◆  NullValuePtr()

static const MAXON_METHOD DataDescriptionDefinitionInterface * NullValuePtr ( )
static