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

# fz_objt_alys_get_segt_spline_parm

Description

Gets the parameters of the underlying curve geometry of a segment of an object, if the geometry of the segment is of type spline ( FZ_OBJT_SEGT_GEOM_TYPE_SPLN).
The control points and weights arrays must be preallocated to hold ncpts values. knots must be preallocated to hold ncpts + degree + 1.
This can be done by calling this function first with all the optional return parameters set to NULL except ncpts and degree.
Use those values to preallocate knots, cpts and weights.

Plugin Prototype

fzrt_error_td fz_objt_alys_get_segt_spline_parm(

fzrt_int | windex,
fz_objt_ptr | obj,
fzrt_int | sindx,
fzrt_int * | ncpts,
fzrt_int * | degree,
double * | knots,
fzrt_boolean * | rational,
fz_xyz_td * | cpts,
double * | weights )

Parameters

windex [Input]

project window index

obj [Input]

object

sindx [Input]

segment index

ncpts [Result, Optional]

number of control points

degree [Result, Optional]

degree of the spline curve

knots [Result, Optional]

knot values array
must be preallocated to store ncpts + degree + 1 values

rational [Result, Optional]

is the curve rational
a spline curve is rational if any of the weights are not equal.
If a curve is not rational, the weights array does not need to be retrieved (i.e. all weights can be considered 1.0).

cpts [Result, Optional]

spline curve control points
must be preallocated to store ncpts values

weights [Result, Optional]

weights of the spline curve
must be preallocated to store ncpts values

Returns

Error codes
MODEL_ERR_INVALID_SEGT - invalid segment type

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_pnt_on_segt, fz_objt_alys_get_segt_arc_parm, fz_objt_alys_get_segt_pspace_arc_parm, fz_objt_alys_get_segt_pspace_spline_parm

Function Set

fz_model_fset

Defined in

fz_objt_alys_api.h