MatAssignData Class Reference

#include <customgui_matassign.h>

Inheritance diagram for MatAssignData:

详细描述

Material assignment custom data type ( CUSTOMDATATYPE_MATASSIGN ).

私有成员函数

  MatAssignData ()
  ~MatAssignData ()

材质

void  SetMaterial (const AtomArray &materials)
Bool   GetMaterial ( BaseDocument *doc, AtomArray &materials)

对象

Bool   InsertObject ( BaseList2D *pObject, Int32 lFlags)
Bool   DeleteObject ( BaseDocument *doc, BaseList2D *pObject)
Bool   DeleteObject ( Int32 lIndex)
Int32   GetObjectIndex ( BaseDocument *doc, BaseList2D *pObject)
BaseList2D ObjectFromIndex ( BaseDocument *doc, Int32 lIndex)
Int32   GetObjectCount ()

Flags

Int32   GetFlags ( Int32 lIndex)
Int32   GetFlags ( BaseDocument *doc, BaseList2D *pObject)

数据

BaseContainer GetData ( Int32 lIndex)
BaseContainer GetData ( BaseDocument *doc, BaseList2D *pObject)

Inclusion Table

MatAssignTable BuildInclusionTable ( BaseDocument *doc, Int32 hierarchy_bit= NOTOK )

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

◆  MatAssignData()

MatAssignData () private

◆  ~MatAssignData()

~ MatAssignData () private

成员函数文档编制

◆  SetMaterial()

void SetMaterial ( const AtomArray materials )

Sets the materials.

参数
[in] materials The materials.

◆  GetMaterial()

Bool GetMaterial ( BaseDocument doc ,
AtomArray materials  
)

Retrieves the materials.

参数
[in] doc The document for the materials. The caller owns the pointed document.
[out] materials Filled with the materials.
返回
true if successful, otherwise false .

◆  InsertObject()

Bool InsertObject ( BaseList2D pObject ,
Int32   lFlags  
)

Inserts an object into the list.

参数
[in] pObject The object to insert. The caller owns the pointed object.
[in] lFlags A bit field for the initial selection state of pObject .
返回
true if successful, otherwise false .

◆  DeleteObject() [1/2]

Bool DeleteObject ( BaseDocument doc ,
BaseList2D pObject  
)

Deletes an object from the list.

参数
[in] doc The document for pObject . The caller owns the pointed document.
[in] pObject The object to delete. The caller owns the pointed object.
返回
true if successful, otherwise false .

◆  DeleteObject() [2/2]

Bool DeleteObject ( Int32   lIndex )

Deletes an object by index.

参数
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
true if successful, otherwise false .

◆  GetObjectIndex()

Int32 GetObjectIndex ( BaseDocument doc ,
BaseList2D pObject  
)

Gets an object's index in the list.

参数
[in] doc The document for pObject . The caller owns the pointed document.
[in] pObject The object to get the index for. The caller owns the pointed object.
返回
The object index, or NOTOK if it is not found.

◆  ObjectFromIndex()

BaseList2D * ObjectFromIndex ( BaseDocument doc ,
Int32   lIndex  
)

Gets an object by index.

参数
[in] doc The document for the object. The caller owns the pointed document.
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
The object, as inserted with InsertObject() .

◆  GetObjectCount()

Int32 GetObjectCount ( )

Gets the object count.

返回
The number of objects in the list.

◆  GetFlags() [1/2]

Int32 GetFlags ( Int32   lIndex )

Gets the flags of an object by index.

参数
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
A bit field for the selection state of the object at lIndex in the list.

◆  GetFlags() [2/2]

Int32 GetFlags ( BaseDocument doc ,
BaseList2D pObject  
)

Gets the flags of an object.

参数
[in] doc The document for pObject . The caller owns the pointed document.
[in] pObject The object to get the flags for. The caller owns the pointed object.
返回
A bit field for the initial selection state of pObject .

◆  GetData() [1/2]

BaseContainer * GetData ( Int32   lIndex )

Retrieves the data for an object by index.

参数
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
The data.

◆  GetData() [2/2]

BaseContainer * GetData ( BaseDocument doc ,
BaseList2D pObject  
)

Gets the data for an object.

参数
[in] doc The document for pObject . The caller owns the pointed document.
[in] pObject The object to get the data for. The caller owns the pointed object.
返回
The data.

◆  BuildInclusionTable()

MatAssignTable * BuildInclusionTable ( BaseDocument doc ,
Int32   hierarchy_bit = NOTOK  
)

Builds a material inclusion table containing all included objects.

参数
[in] doc The document. The caller owns the pointed document.
[in] hierarchy_bit The hierarchy bit. Starts at 0 .
返回
The inclusion table. Delete the list by calling FreeInclusionTable ( table ).