formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Analysis
Description
Calculates the tangent direction on a segment, given a ratio parameter. If ratio is 0.0, the tangent at the begin point of the segment is returned. If ratio is 1.0, the tangent at the end point of the segment is returned. A value between 0.0 and 1.0 interpolates the tangent point linearly along the segment direction. Foe example to get the tangent at the midpoint of the segment, pass in 0.5 for ratio. To get the tangent at the quarter point, pass in 0.25 etc.
Plugin Prototype
fzrt_error_td fz_objt_alys_get_tangent_on_segt(
fzrt_int | windex, |
obj, | |
fzrt_int | sindx, |
model_type, | |
double | ratio, |
tangent ) |
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
tangent [Result]
tangent at point on segment
Returns
Error codes
Availability
7.0.0.0
Example Files
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, fz_objt_alys_get_pnt_on_segt
Function Set
Defined in