Class: RubyOSBXL::Dto::RectangleGradientObject

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyosbxl.rb

Overview

パスグラデーションフィルを扱うクラスです。

Instance Method Summary collapse

Constructor Details

#initialize ⇒ void

コンストラクタ

インスタンスを作成します。

Instance Method Details

#addColorStop(val, stop) ⇒ void

グラディエントの色分岐点オブジェクトを追加します。

Parameters:

  • val (Numeric) —

    ストップ値(0.0～1.0) 既に存在するストップ値を追加することはできません。

  • stop (RubyOSBXL::Dto::ColorStopObject) —

    ストップ値に対応する色オブジェクト

#clearColorStop ⇒ void

グラディエントの色分岐点オブジェクト全体を削除します。

#getBottom ⇒ Numeric

グラディエントの下端を取得します。

Returns:

  • (Numeric) —

    下端(閾値: 0.0～1.0)

#getColorStops ⇒ Array<RubyOSBXL::Dto::ColorStopObject>

グラディエントの色分岐点オブジェクト群を取得します。

Returns:

#getColorStopsValues ⇒ Array<Numeric>

グラディエントの色分岐点オブジェクトのキー(ストップ値)の全体を取得します。(各々の値は、0~1の範囲で、一意です)

Returns:

  • (Array<Numeric>) —

    Array<number>

#getLeft ⇒ Numeric

グラディエントの左端を取得します。

Returns:

  • (Numeric) —

    左端(閾値: 0.0～1.0)

#getRight ⇒ Numeric

グラディエントの右端を取得します。

Returns:

  • (Numeric) —

    右端(閾値: 0.0～1.0)

#getTop ⇒ Numeric

グラディエントの上端を取得します。

Returns:

  • (Numeric) —

    上端(閾値: 0.0～1.0)

#removeColorStop(val) ⇒ void

グラディエントの色分岐点オブジェクトを削除します。

Parameters:

  • val (Numeric) —

    ストップ値(閾値: 0.0～1.0)

#setBottom(bottom) ⇒ void

グラディエントの下端を設定します。

Parameters:

  • bottom (Numeric) —

    下端(閾値: 0.0～1.0)

#setLeft(left) ⇒ void

グラディエントの左端を設定します。

Parameters:

  • left (Numeric) —

    左端(閾値: 0.0～1.0)

#setRight(right) ⇒ void

グラディエントの右端を設定します。

Parameters:

  • right (Numeric) —

    右端(閾値: 0.0～1.0)

#setTop(ptop) ⇒ void

グラディエントの上端を設定します。

Parameters:

  • ptop (Numeric) —

    上端(閾値: 0.0～1.0)