VS:GetGradientDataN/ja

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

PROCEDURE GetGradientDataN(
              gradient               :HANDLE;
              segmentIndex           :INTEGER;
              VAR spotPosition       :REAL;
              VAR midpointPosition   :REAL;
              VAR red                :LONGINT;
              VAR green              :LONGINT;
              VAR blue               :LONGINT;
              VAR opacity            :INTEGER);

def vs.GetGradientDataN(gradient, segmentIndex):
    return (Boolean, spotPosition, midpointPosition, red, green, blue, opacity)

Parameters

gradient		HANDLE		グラデーションのハンドル
segmentIndex		INTEGER		変化位置番号（最も左を1とする）
spotPosition		REAL		変化点の位置
midpointPosition		REAL		変化の中心点の位置
red		LONGINT		変化点の色の赤成分
green		LONGINT		変化点の色の緑成分
blue		LONGINT		変化点の色の青成分
opacity		INTEGER		変化点の色の不透明度

Example

PROCEDURE Example;
VAR
gradient :HANDLE;
segmentIndex :INTEGER;
spotPosition, midpointPosition :REAL;
red, green, blue :LONGINT;
opacity :INTEGER
BEGIN
gradient := GetObject('Cyan-Magenta-Yellow');
segmentIndex := 3;
GetGradientData(gradient, segmentIndex, spotPosition, midpointPosition, red, green, blue.opacity);
Message(red, ' ', green, ' ', blue, ' ', opacity);
END;
RUN(Example);

Version

Availability: from Vectorworks 2015

See Also

VS Functions:

VS:SetGradientDataN | VS:InsertGradientData

VS Functions:

[[VS:SetGradientDataN]]

| [[VS:InsertGradientData]]