BaseBitmapLink Class Reference

#include <c4d_basebitmap.h>

Detailed Description

An alias link to a bitmap. If the bitmap is deleted it will return nullptr.

Note

Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Private Member Functions
	BaseBitmapLink ()
	~BaseBitmapLink ()

Alloc/Free
static BaseBitmapLink *	Alloc ()
static void	Free (BaseBitmapLink *&bll)

Get/Set Link
BaseBitmap *	Get () const
void	Set (BaseBitmap *bmp)

Constructor & Destructor Documentation

BaseBitmapLink()

BaseBitmapLink ( )

private

~BaseBitmapLink()

~BaseBitmapLink ( )

private

Member Function Documentation

Alloc()

static BaseBitmapLink* Alloc ( )

static

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

Returns

The allocated bitmap link, or nullptr if the allocation failed.

Free()

static void Free ( BaseBitmapLink *&  bll )

static

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

Parameters

[in]

bll

The bitmap link to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

Get()

BaseBitmap* Get

(

)

const

Gets the linked bitmap.

Returns

The linked bitmap, or nullptr if the bitmap was deleted.

Set()

void Set

(

BaseBitmap *

bmp

)

Sets the link for the bitmap.

Parameters

[in]

bmp

The bitmap to be linked.