GeMarker Class Reference

#include <c4d_baselist.h>

Detailed Description

A unique marker that identifies an object.

Public Member Functions
Bool	IsPopulated () const
Bool	IsEqual (const GeMarker &m) const
Int32	Compare (const GeMarker &m) const
void	Set (const GeMarker &m)
Bool	Read (HyperFile *hf)
Bool	Write (HyperFile *hf) const
void	GetMemory (void *&data, Int32 &size) const

Static Public Member Functions
static GeMarker *	Alloc ()
static void	Free (GeMarker *&obj)

Private Member Functions
	GeMarker ()
	~GeMarker ()

Constructor & Destructor Documentation

GeMarker()

GeMarker ( )

private

~GeMarker()

~GeMarker ( )

private

Member Function Documentation

Alloc()

static GeMarker* Alloc ( )

static

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

Returns

The allocated marker, or nullptr if the allocation failed.

Free()

static void Free ( GeMarker *&  obj )

static

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

Parameters

[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.

Returns

true if the marker has been set, otherwise false.

IsEqual()

Bool IsEqual

(

const GeMarker &

m

)

const

Checks if two markers are equal.

Parameters

[in]

m

The marker to compare with.

Returns

true if both markers are equal, otherwise false.

Compare()

Int32 Compare

(

const GeMarker &

m

)

const

Compares two markers.

Parameters

[in]

m

The marker to compare with.

Returns

0 if identical and !=0 if different.

Set()

void Set

(

const GeMarker &

m

)

Sets a marker the same as another marker.

Parameters

[in]

m

The new marker.

Read()

Bool Read

(

HyperFile *

hf

)

Reads the marker from a hyper file.

Parameters

[in]

hf

The hyper file to read from. The caller owns the pointed object.

Returns

true if the marker was read, otherwise false.

Write()

Bool Write

(

HyperFile *

hf

)

const

Writes the marker to a hyper file.

Parameters

[in]

hf

The hyper file to write to. The caller owns the pointed object.

Returns

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.

Note

The memory must not be freed.

Parameters

[out]	data	The memory pointer.
[out]	size	The size of the memory block.