Skip to content

GetGradientMidpointPosition.md

Latest commit

 

History

History
52 lines (42 loc) · 1.3 KB

GetGradientMidpointPosition.md

File metadata and controls

52 lines (42 loc) · 1.3 KB
Raw

GetGradientMidpointPosition

Description

Gets the midpoint position of the specified gradient segment.

PROCEDURE GetGradientMidpointPosition(
				gradient     : HANDLE;
				segmentIndex : INTEGER;
				VAR position : REAL);
def vs.GetGradientMidpointPosition(gradient, segmentIndex):
    return position

Parameters

Name Type Description
gradient HANDLE Gradient that contains the segment.
segmentIndex INTEGER Segment from which to get the data.
position REAL Position of the segment's midpoint relatvie to color spot immediately to left.

Examples

VectorScript

GetGradientMidpointPosition(gradientHandle, 4, midpointPosition);

Python

midpointPosition = vs.GetGradientMidpointPosition(gradientHandle, 4)
GetGradientMidpointPosition(gradient, 1, 1.0);
import vs

# Gets the midpoint position of the specified gradient segment.
gradient = vs.FSActLayer()  # handle to the first selected object on the active layer
segmentIndex = 1

result = vs.GetGradientMidpointPosition(gradient, segmentIndex)

Version

Availability: from VectorWorks10.0

Category