GradientCustomGui Class Reference

#include <customgui_gradient.h>

Inheritance diagram for GradientCustomGui:

详细描述

渐变 GUI ( CUSTOMGUI_GRADIENT ) for the 渐变 data type. Here are the settings: GRADIENTPROPERTY_CUSTOMGUISETTINGS

私有成员函数

  GradientCustomGui ()
  ~GradientCustomGui ()

Gradient Data

渐变 GetGradient ()
Bool   SetGradient ( 渐变 *grad)

Active Knots/Biasses

maxon::Result < maxon::BaseArray < Int32 > >  GetActiveKnots ( Bool bias)
maxon::Result < void >  SetActiveKnots (const maxon::BaseArray < Int32 > &activeIndexList, Bool bias, Bool addToSelection)

Additional Inherited Members

-  Public Member Functions inherited from BaseCustomGui< 1000480 >
Int32   GetWidth ()
Int32   GetHeight ()
void  Redraw ()
Bool   LayoutChanged ()
Bool   激活 ()
Bool   SetDefaultForResEdit ()
Bool   SetData (const TriState < GeData > &tristate)
TriState < GeData GetData ()
void  SetLayoutMode ( Int32 mode)
Int32   GetLayoutMode ()
Bool   SupportLayoutSwitch ()
-  Public Member Functions inherited from _BaseCustomGui
Int32   GetWidth ( Int32 plugid)
Int32   GetHeight ( Int32 plugid)
void  Redraw ( Int32 plugid)
Bool   LayoutChanged ( Int32 plugid)
Bool   激活 ( Int32 plugid)
Bool   SetDefaultForResEdit ( Int32 plugid)
Bool   SetData ( Int32 plugid, const TriState < GeData > &tristate)
TriState < GeData GetData ( Int32 plugid)
void  SetLayoutMode ( Int32 plugid, Int32 mode)
Int32   GetLayoutMode ( Int32 plugid)
Bool   SupportLayoutSwitch ( Int32 plugid)

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

◆  GradientCustomGui()

GradientCustomGui () private

◆  ~GradientCustomGui()

~ GradientCustomGui () private

成员函数文档编制

◆  GetGradient()

渐变 * GetGradient ( )

Gets the gradient data.

返回
The gradient data.

◆  SetGradient()

Bool SetGradient ( 渐变 grad )

Sets the gradient data.

警告
Unlike SetData() it sends a parent GUI message, causing parent GUI elements (e.g. a shader or dialog that contains the gradient custom GUI) to update automatically.
注意
It is recommended to call SetData() instead, because SetGradient() just sets grad instance and if there is an alpha gradient, it will be destroyed.
With SetData() it needs some more lines of code but alpha gradients will be preserved.
参数
[in] grad The gradient data to set. The caller owns the pointed gradient data.
返回
true if successful, otherwise false .

◆  GetActiveKnots()

maxon::Result < maxon::BaseArray < Int32 > > GetActiveKnots ( Bool   bias )

Gets the active knots or biassses control indexes.

参数
[in] bias Set to true to get the active biasses index, otherwise it will get the active knots indexes.
返回
The active knot index list.

◆  SetActiveKnots()

maxon::Result <void> SetActiveKnots ( const maxon::BaseArray < Int32 > &  activeIndexList ,
Bool   bias ,
Bool   addToSelection  
)

Sets the active knots or biasses controls.

参数
[in] activeIndexList The knots or biasses index list to set.
[in] bias Pass true to select biasses, otherwise knots.