VS:GetGradientMidpointPosition

From Vectorworks Developer
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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

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

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.

Example

VectorScript

GetGradientMidpointPosition(gradientHandle, 4, midpointPosition);

Python

midpointPosition = vs.GetGradientMidpointPosition(gradientHandle, 4)

Version

Availability: from VectorWorks10.0