formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Analysis

# fz_objt_alys_get_pnt_on_segt

Description

Calculates a point on a segment of an object, given a ratio parameter. If ratio is 0.0, the begin point of the segment is returned. If ratio is 1.0, the end point of the segment is returned. A value between 0.0 and 1.0 interpolates the point linearly along the segment direction. For example to get the midpoint of the segment, pass in 0.5 for ratio. To get the quarter point, pass in 0.25 etc..

Plugin Prototype

fzrt_error_td fz_objt_alys_get_pnt_on_segt(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_int | sindx,
fz_objt_model_type_enum | model_type,
double | ratio,
fz_xyz_td * | pt )

Parameters

windex [Input]

project window index

obj [Input]

object

sindx [Input]

segment index

model_type [Input]

object topology type. FZ_OBJT_MODEL_TYPE_UNSPEC may be used to use the object's natural model type.

ratio [Input]

ratio

pt [Result]

point on segment

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_alys_face.fsl

See Also

fz_objt_alys_get_segt_geom_type, fz_objt_alys_get_segt_bbox,, fz_objt_alys_get_segt_arc_parm, fz_objt_alys_get_segt_spline_parm,

Function Set

fz_model_fset

Defined in

fz_objt_alys_api.h