GeMarker Class Reference

#include <c4d_baselist.h>

详细描述

A unique marker that identifies an object.

公共成员函数

Bool   IsPopulated () const
Bool   IsEqual (const GeMarker &m) const
Int32   比较 (const GeMarker &m) const
void  Set (const GeMarker &m)
Bool   读取 ( HyperFile *hf)
Bool   Write ( HyperFile *hf) const
void  GetMemory (void *&data, Int32 &size) const

静态公共成员函数

static GeMarker Alloc ()
static void  Free ( GeMarker *&obj)

私有成员函数

  GeMarker ()
  ~GeMarker ()

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

◆  GeMarker()

GeMarker () private

◆  ~GeMarker()

~ GeMarker () private

成员函数文档编制

◆  Alloc()

static GeMarker * Alloc ( )
static

Allocates a marker. Destroy the allocated marker with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

返回
The allocated marker, or nullptr if the allocation failed.

◆  Free()

static void Free ( GeMarker *&  obj )
static

Destructs markers allocated with Alloc() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

参数
[in,out] obj The marker to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆  IsPopulated()

Bool IsPopulated ( ) const

Checks if the marker is empty.

返回
true if the marker has been set, otherwise false .

◆  IsEqual()

Bool IsEqual ( const GeMarker m ) const

Checks if two markers are equal.

参数
[in] m The marker to compare with.
返回
true if both markers are equal, otherwise false .

◆  Compare()

Int32 比较 ( const GeMarker m ) const

Compares two markers.

参数
[in] m The marker to compare with.
返回
0 if identical and !=0 if different.

◆  Set()

void Set ( const GeMarker m )

Sets a marker the same as another marker.

参数
[in] m The new marker.

◆  Read()

Bool 读取 ( HyperFile hf )

Reads the marker from a hyper file.

参数
[in] hf The hyper file to read from. The caller owns the pointed object.
返回
true if the marker was read, otherwise false .

◆  Write()

Bool Write ( HyperFile hf ) const

Writes the marker to a hyper file.

参数
[in] hf The hyper file to write to. The caller owns the pointed object.
返回
true if the marker was written, otherwise false .

◆  GetMemory()

void GetMemory ( void *&  data ,
Int32 size  
) const

Gets a memory pointer and the size of the memory block.
Used for instance to create a checksum.

注意
The memory must not be freed.
参数
[out] data The memory pointer.
[out] size The size of the memory block.