LayerSetInterface Class Reference

#include <layerset.h>

详细描述

Class to choose layers or alphas from an image.

Public Types

using  LayerHash = HashSet < String , LayerSetCompare >

公共成员函数

MAXON_METHOD Result < void >  SetSelectedLayers (const LayerHash &layers)
const MAXON_METHOD LayerHash GetSelectedLayers () const
MAXON_METHOD void  SetSelectedImage (const String &image)
MAXON_METHOD String   GetSelectedImage () const
MAXON_METHOD void  SetMode ( LAYERSETMODE mode)
MAXON_METHOD LAYERSETMODE   GetMode () const
MAXON_METHOD void  SetCalculateAlpha ( Bool calcAlpha)
MAXON_METHOD Bool   GetCalculateAlpha () const
MAXON_METHOD Bool   IsEqual (const LayerSetInterface *other) const
MAXON_METHOD HashInt   GetHashCode () const
MAXON_FUNCTION void  FlushLayers ()
MAXON_FUNCTION Bool   HasLayerSelection () const
MAXON_FUNCTION Bool   IsLayerEnabled (const String &name) const
MAXON_FUNCTION Bool   HasMultiImageSelection () const
MAXON_FUNCTION Bool   IsMultiImageEnabled (const String &name) const
MAXON_FUNCTION Result < void >  RemoveLayer (const String &layer)
MAXON_FUNCTION Result < void >  AddLayer (const String &layer)

静态公共成员函数

static MAXON_METHOD Result < void >  DescribeIO (const DataSerializeInterface &stream)

私有成员函数

  MAXON_INTERFACE_NONVIRTUAL ( LayerSetInterface , MAXON_REFERENCE_COPY_ON_WRITE , "net.maxon.interface.layerset")

Member Typedef Documentation

◆  LayerHash

using LayerHash = HashSet < String , LayerSetCompare >

成员函数文档编制

◆  MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( LayerSetInterface   ,
MAXON_REFERENCE_COPY_ON_WRITE   ,
"net.maxon.interface.layerset"   
)
private

◆  SetSelectedLayers()

MAXON_METHOD Result <void> SetSelectedLayers ( const LayerHash layers )

Sets the selected layers.

参数
[in] layers The layers to set.
返回
OK on success.

◆  GetSelectedLayers()

const MAXON_METHOD LayerHash & GetSelectedLayers ( ) const

Gets the selected layers.

返回
The layers.

◆  SetSelectedImage()

MAXON_METHOD void SetSelectedImage ( const String image )

Sets the selected image.

参数
[in] image The image to set.

◆  GetSelectedImage()

MAXON_METHOD String GetSelectedImage ( ) const

Gets the selected image.

返回
The image.

◆  SetMode()

MAXON_METHOD void SetMode ( LAYERSETMODE   mode )

Sets the mode.

参数
[in] mode The mode to set.

◆  GetMode()

MAXON_METHOD LAYERSETMODE GetMode ( ) const

Gets the mode.

返回
The mode.

◆  SetCalculateAlpha()

MAXON_METHOD void SetCalculateAlpha ( Bool   calcAlpha )

Sets the alpha calculation mode.

参数
[in] calcAlpha The mode to set.

◆  GetCalculateAlpha()

MAXON_METHOD Bool GetCalculateAlpha ( ) const

Gets the alpha calculation mode.

返回
The mode.

◆  IsEqual()

MAXON_METHOD Bool IsEqual ( const LayerSetInterface other ) const

Compares this LayerSet with another one if both are identical.

参数
[in] other The other LayerSet to compare this object to.
返回
True if the object is identical.

◆  GetHashCode()

MAXON_METHOD HashInt GetHashCode ( ) const

◆  FlushLayers()

MAXON_FUNCTION void FlushLayers ( )

◆  HasLayerSelection()

MAXON_FUNCTION Bool HasLayerSelection ( ) const

◆  IsLayerEnabled()

MAXON_FUNCTION Bool IsLayerEnabled ( const String name ) const

◆  HasMultiImageSelection()

MAXON_FUNCTION Bool HasMultiImageSelection ( ) const

◆  IsMultiImageEnabled()

MAXON_FUNCTION Bool IsMultiImageEnabled ( const String name ) const

◆  RemoveLayer()

MAXON_FUNCTION Result <void> RemoveLayer ( const String layer )

◆  AddLayer()

MAXON_FUNCTION Result <void> AddLayer ( const String layer )

◆  DescribeIO()

static MAXON_METHOD Result <void> DescribeIO ( const DataSerializeInterface stream )
static

Describe all elements of this class for I/O operations.

参数
[in] stream The stream that is used to register the class members.
返回
OK on success.