Skip to content

GetNumGradientSegments.md

Latest commit

 

History

History
52 lines (40 loc) · 1.16 KB

GetNumGradientSegments.md

File metadata and controls

52 lines (40 loc) · 1.16 KB
Raw

GetNumGradientSegments

Description

Gets the number of segments in the gradient.

FUNCTION GetNumGradientSegments(gradient : HANDLE): INTEGER;
def vs.GetNumGradientSegments(gradient):
    return INTEGER

Parameters

Name Type Description
gradient HANDLE The gradient from which to get the number of segments.

Remarks

Note: a gradient must always have at least 2 segments.

This also returns the number of levels in a hatch definition, like [{VS:GetObjectVariableInt]](HatchDefH, 660).

Examples

VectorScript

numSegments := GetNumGradientSegments(gradientHandle);

Python

numSegments = vs.GetNumGradientSegments(gradientHandle)
resultN := GetNumGradientSegments(gradient);
import vs

# Gets the number of segments in the gradient.
gradient = vs.FSActLayer()  # handle to the first selected object on the active layer

count = vs.GetNumGradientSegments(gradient)
vs.Message('GetNumGradientSegments returned: ' + str(count))

Version

Availability: from VectorWorks10.0

Category