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

LayerSet Class Reference

#include <customgui_layerset.h>

Inheritance diagram for LayerSet:
Inheritance graph
[ legend ]

详细描述

Layer set custom data type ( CUSTOMDATATYPE_LAYERSET ).

公共成员函数

Bool   IsPopulated () const
Bool   IsLayerEnabled (const maxon::String &name) const
Bool   FindLayerSet (const maxon::String &name) const
String   GetName () const
LAYERSETMODE   GetMode () const
void  SetMode ( LAYERSETMODE t_mode)
void  RemoveLayer (const maxon::String &layer)
void  AddLayer (const maxon::String &layer)
void  FlushLayers ()
void  SetPreviewMode ( Int32 s)
Int32   GetPreviewMode (void)
const LayerSet &  operator= (const LayerSet &layerset)
Bool   operator== (const LayerSet &layerset) const
void  CopyTo ( LayerSet &dst) const

私有成员函数

  LayerSet ()
  ~LayerSet ()

Alloc/Free

static LayerSet *  Alloc ()
static void  Free ( LayerSet *layerset)

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

◆  LayerSet()

LayerSet () private

◆  ~LayerSet()

~ LayerSet () private

成员函数文档编制

◆  IsPopulated()

Bool IsPopulated ( ) const

Checks if the layer set has content.

返回
true if the set contains any layer, otherwise false .

◆  IsLayerEnabled()

Bool IsLayerEnabled ( const maxon::String &  name ) const

Checks if a layer is enabled.

参数
[in] name The name of the layer to check for.
返回
true if the layer is enabled, otherwise false .

◆  FindLayerSet()

Bool FindLayerSet ( const maxon::String &  name ) const

Checks if a layer is in the set.

参数
[in] name The name of the layer to check for.
返回
true if the layer is in the set, otherwise false .

◆  GetName()

String GetName ( ) const

Gets the set's name.

返回
The name of the set.

◆  GetMode()

LAYERSETMODE GetMode ( ) const

Gets the layer set mode.

返回
The mode: LAYERSETMODE

◆  SetMode()

void SetMode ( LAYERSETMODE   t_mode )

Sets a new layer set mode.

参数
[in] t_mode The mode to set: LAYERSETMODE

◆  RemoveLayer()

void RemoveLayer ( const maxon::String &  layer )

Removes a layer.

参数
[in] layer The name of the layer to remove.

◆  AddLayer()

void AddLayer ( const maxon::String &  layer )

Adds a layer.

参数
[in] layer The name of the layer to add.

◆  FlushLayers()

void FlushLayers ( )

Flushes all layers.

◆  SetPreviewMode()

void SetPreviewMode ( Int32   s )

Sets the preview mode.

参数
[in] s The preview mode to set.

◆  GetPreviewMode()

Int32 GetPreviewMode ( void  )

Gets the preview mode.

返回
The current preview mode.

◆  operator=()

const LayerSet & operator= ( const LayerSet &  layerset )

Assignment operator. Copies the source layerset .

参数
[in] layerset The source layer set.
返回
The assigned layer set to the left-operand.

◆  operator==()

Bool operator== ( const LayerSet &  layerset ) const

Equality operator. Checks if the set and layerset are equal.

参数
[in] layerset The layer set to compare with.
返回
true if the layer sets are equal, otherwise false .

◆  CopyTo()

void CopyTo ( LayerSet &  dst ) const

Copies the layer set to dst .

参数
[in] dst The destination layer set.

◆  Alloc()

static LayerSet * Alloc ( )
static

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

返回
The allocated layer set data, or nullptr if the allocation failed.

◆  Free()

static void Free ( LayerSet *  layerset )
static

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

参数
[in,out] layerset The layer set data to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.