Operator Reference

draw_nurbs_interp_modT_draw_nurbs_interp_modDrawNurbsInterpModDrawNurbsInterpModdraw_nurbs_interp_mod (Operator)

draw_nurbs_interp_modT_draw_nurbs_interp_modDrawNurbsInterpModDrawNurbsInterpModdraw_nurbs_interp_mod — Interactive modification of a NURBS curve using interpolation.

Warning

This operator does not work in an HDevelop graphics window opened with dev_open_window.

Signature

Herror T_draw_nurbs_interp_mod(Hobject* ContOut, const Htuple WindowHandle, const Htuple Rotate, const Htuple Move, const Htuple Scale, const Htuple KeepRatio, const Htuple Edit, const Htuple Degree, const Htuple RowsIn, const Htuple ColsIn, const Htuple TangentsIn, Htuple* ControlRows, Htuple* ControlCols, Htuple* Knots, Htuple* Rows, Htuple* Cols, Htuple* Tangents)

void DrawNurbsInterpMod(HObject* ContOut, const HTuple& WindowHandle, const HTuple& Rotate, const HTuple& Move, const HTuple& Scale, const HTuple& KeepRatio, const HTuple& Edit, const HTuple& Degree, const HTuple& RowsIn, const HTuple& ColsIn, const HTuple& TangentsIn, HTuple* ControlRows, HTuple* ControlCols, HTuple* Knots, HTuple* Rows, HTuple* Cols, HTuple* Tangents)

void HXLDCont::DrawNurbsInterpMod(const HWindow& WindowHandle, const HString& Rotate, const HString& Move, const HString& Scale, const HString& KeepRatio, const HString& Edit, Hlong Degree, const HTuple& RowsIn, const HTuple& ColsIn, const HTuple& TangentsIn, HTuple* ControlRows, HTuple* ControlCols, HTuple* Knots, HTuple* Rows, HTuple* Cols, HTuple* Tangents)

void HXLDCont::DrawNurbsInterpMod(const HWindow& WindowHandle, const char* Rotate, const char* Move, const char* Scale, const char* KeepRatio, const char* Edit, Hlong Degree, const HTuple& RowsIn, const HTuple& ColsIn, const HTuple& TangentsIn, HTuple* ControlRows, HTuple* ControlCols, HTuple* Knots, HTuple* Rows, HTuple* Cols, HTuple* Tangents)

void HXLDCont::DrawNurbsInterpMod(const HWindow& WindowHandle, const wchar_t* Rotate, const wchar_t* Move, const wchar_t* Scale, const wchar_t* KeepRatio, const wchar_t* Edit, Hlong Degree, const HTuple& RowsIn, const HTuple& ColsIn, const HTuple& TangentsIn, HTuple* ControlRows, HTuple* ControlCols, HTuple* Knots, HTuple* Rows, HTuple* Cols, HTuple* Tangents)   ( Windows only)

HXLDCont HWindow::DrawNurbsInterpMod(const HString& Rotate, const HString& Move, const HString& Scale, const HString& KeepRatio, const HString& Edit, Hlong Degree, const HTuple& RowsIn, const HTuple& ColsIn, const HTuple& TangentsIn, HTuple* ControlRows, HTuple* ControlCols, HTuple* Knots, HTuple* Rows, HTuple* Cols, HTuple* Tangents) const

HXLDCont HWindow::DrawNurbsInterpMod(const char* Rotate, const char* Move, const char* Scale, const char* KeepRatio, const char* Edit, Hlong Degree, const HTuple& RowsIn, const HTuple& ColsIn, const HTuple& TangentsIn, HTuple* ControlRows, HTuple* ControlCols, HTuple* Knots, HTuple* Rows, HTuple* Cols, HTuple* Tangents) const

HXLDCont HWindow::DrawNurbsInterpMod(const wchar_t* Rotate, const wchar_t* Move, const wchar_t* Scale, const wchar_t* KeepRatio, const wchar_t* Edit, Hlong Degree, const HTuple& RowsIn, const HTuple& ColsIn, const HTuple& TangentsIn, HTuple* ControlRows, HTuple* ControlCols, HTuple* Knots, HTuple* Rows, HTuple* Cols, HTuple* Tangents) const   ( Windows only)

static void HOperatorSet.DrawNurbsInterpMod(out HObject contOut, HTuple windowHandle, HTuple rotate, HTuple move, HTuple scale, HTuple keepRatio, HTuple edit, HTuple degree, HTuple rowsIn, HTuple colsIn, HTuple tangentsIn, out HTuple controlRows, out HTuple controlCols, out HTuple knots, out HTuple rows, out HTuple cols, out HTuple tangents)

void HXLDCont.DrawNurbsInterpMod(HWindow windowHandle, string rotate, string move, string scale, string keepRatio, string edit, int degree, HTuple rowsIn, HTuple colsIn, HTuple tangentsIn, out HTuple controlRows, out HTuple controlCols, out HTuple knots, out HTuple rows, out HTuple cols, out HTuple tangents)

HXLDCont HWindow.DrawNurbsInterpMod(string rotate, string move, string scale, string keepRatio, string edit, int degree, HTuple rowsIn, HTuple colsIn, HTuple tangentsIn, out HTuple controlRows, out HTuple controlCols, out HTuple knots, out HTuple rows, out HTuple cols, out HTuple tangents)

def draw_nurbs_interp_mod(window_handle: HHandle, rotate: str, move: str, scale: str, keep_ratio: str, edit: str, degree: int, rows_in: Sequence[float], cols_in: Sequence[float], tangents_in: Sequence[float]) -> Tuple[HObject, Sequence[float], Sequence[float], Sequence[float], Sequence[float], Sequence[float], Sequence[float]]

Description

draw_nurbs_interp_moddraw_nurbs_interp_modDrawNurbsInterpModDrawNurbsInterpModdraw_nurbs_interp_mod returns the contour ContOutContOutContOutcontOutcont_out of a NURBS curve of degree DegreeDegreeDegreedegreedegree, which has been modified interactively by the user in the window WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle.

In addition to ContOutContOutContOutcontOutcont_out the control information of the curve (ControlRowsControlRowsControlRowscontrolRowscontrol_rows, ControlColsControlColsControlColscontrolColscontrol_cols, and KnotsKnotsKnotsknotsknots), the interpolation points (RowsRowsRowsrowsrows, ColsColsColscolscols) specified by the user and the tangents at the first and the last point (TangentsTangentsTangentstangentstangents) are returned. TangentsTangentsTangentstangentstangents consists of four values. The first two values correspond to the y (row) and the x (column) value of the tangent at the start of the curve and the second two values to the tangent at the end of the curve, respectively.

The weight vector is not returned because it consists of equal entries. As a consequence one can use 'auto'"auto""auto""auto""auto" as weight vector, if the control information is used in a subsequent call to the operator gen_contour_nurbs_xldgen_contour_nurbs_xldGenContourNurbsXldGenContourNurbsXldgen_contour_nurbs_xld. For more information on NURBS see the documentation of gen_contour_nurbs_xldgen_contour_nurbs_xldGenContourNurbsXldGenContourNurbsXldgen_contour_nurbs_xld.

The input curve is specified by the interpolation points (RowsInRowsInRowsInrowsInrows_in, ColsInColsInColsIncolsIncols_in), its degree DegreeDegreeDegreedegreedegree and the tangents TangentsInTangentsInTangentsIntangentsIntangents_in, such that draw_nurbs_interp_moddraw_nurbs_interp_modDrawNurbsInterpModDrawNurbsInterpModdraw_nurbs_interp_mod can be applied to the output data of draw_nurbs_interpdraw_nurbs_interpDrawNurbsInterpDrawNurbsInterpdraw_nurbs_interp.

You can modify the curve in two ways: by editing the interpolation points, e.g., by inserting or moving points, or by transforming the curve as a whole, e.g., by rotating moving or scaling it. Note that you can only edit the curve if EditEditEditeditedit is set to 'true'"true""true""true""true". Similarly, you can only rotate, move or scale it if RotateRotateRotaterotaterotate, MoveMoveMovemovemove, and ScaleScaleScalescalescale, respectively, are set to 'true'"true""true""true""true".

draw_nurbs_interp_moddraw_nurbs_interp_modDrawNurbsInterpModDrawNurbsInterpModdraw_nurbs_interp_mod starts in the transformation mode. In this mode, the curve is displayed together with 3 symbols: a cross in the middle and an arrow to the right if RotateRotateRotaterotaterotate is set to 'true'"true""true""true""true", and a double-headed arrow to the upper right if ScaleScaleScalescalescale is set to 'true'"true""true""true""true". To switch into the edit mode, press the Shift key; by pressing it again, you can switch back into the transformation mode.

Transformation Mode

In this mode a NURBS curve can be rotated, moved and scaled, as long as the respective parameter RotateRotateRotaterotaterotate, MoveMoveMovemovemove and ScaleScaleScalescalescale are set to 'true'"true""true""true""true". The NURBS curve is displayed along with a cross in its center, an arrow pointing to the right (if RotateRotateRotaterotaterotate is set to 'true'"true""true""true""true"), and a double arrow (if ScaleScaleScalescalescale is set to 'true'"true""true""true""true").

  • To move the curve, click with the left mouse button on the cross in the center and then drag it to the new position, i.e., keep the mouse button pressed while moving the mouse.

  • To rotate it, click with the left mouse button on the arrow and then drag it, till the curve has the right direction.

  • Scaling is achieved by dragging the double arrow. To keep the ratio, the parameter KeepRatioKeepRatioKeepRatiokeepRatiokeep_ratio has to be set to 'true'"true""true""true""true".

Edit Mode

In this mode, the curve is displayed together with its interpolation points and the start and end tangent. Start and end point are marked by an additional square. You can perform the following modifications:

  • To append new points, click with the left mouse button in the window and a new point is added at this position.

  • You can delete the point appended last by pressing the Ctrl key.

  • To move a point, drag it with the mouse.

  • To insert a point on the curve, click on the desired position on the curve.

  • To close respectively open the curve, click on the first or on the last point.

Pressing the right mouse button terminates the procedure.

The appearance of the curve while drawing is determined by the line width, size and color set via the operators set_colorset_colorSetColorSetColorset_color, set_coloredset_coloredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width, and set_line_styleset_line_styleSetLineStyleSetLineStyleset_line_style. The tangents and all handles are displayed in the second color set by set_colorset_colorSetColorSetColorset_color or set_coloredset_coloredSetColoredSetColoredset_colored. Their line width is fixed to 1 and their line style is fixed to a drawn-through line.

Attention

In contrast to draw_nurbsdraw_nurbsDrawNurbsDrawNurbsdraw_nurbs, each point specified by the user influences the whole curve. Thus, if one point is moved, the whole curve can and will change. To minimize this effects, it is recommended to use a small degree (3-5) and to place the points such that they are approximately equally spaced. In general, uneven degrees will perform slightly better than even degrees.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

ContOutContOutContOutcontOutcont_out (output_object)  xld_cont objectHXLDContHObjectHObjectHobject *

Contour of the modified curve.

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

RotateRotateRotaterotaterotate (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Enable rotation?

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

MoveMoveMovemovemove (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Enable moving?

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

ScaleScaleScalescalescale (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Enable scaling?

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

KeepRatioKeepRatioKeepRatiokeepRatiokeep_ratio (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Keep ratio while scaling?

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

EditEditEditeditedit (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Enable editing?

Default: 'true' "true" "true" "true" "true"

List of values: 'false'"false""false""false""false", 'true'"true""true""true""true"

DegreeDegreeDegreedegreedegree (input_control)  integer HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

The degree p of the NURBS curve. Reasonable values are 3 to 5.

Default: 3

Suggested values: 2, 3, 4, 5

Restriction: Degree >= 2 && Degree <= 9

RowsInRowsInRowsInrowsInrows_in (input_control)  coordinates.y-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Row coordinates of the input interpolation points.

ColsInColsInColsIncolsIncols_in (input_control)  coordinates.x-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Column coordinates of the input interpolation points.

TangentsInTangentsInTangentsIntangentsIntangents_in (input_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Input tangents.

ControlRowsControlRowsControlRowscontrolRowscontrol_rows (output_control)  coordinates.y-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Row coordinates of the control polygon.

ControlColsControlColsControlColscontrolColscontrol_cols (output_control)  coordinates.x-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Column coordinates of the control polygon.

KnotsKnotsKnotsknotsknots (output_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Knot vector.

RowsRowsRowsrowsrows (output_control)  coordinates.y-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Row coordinates of the points specified by the user.

ColsColsColscolscols (output_control)  coordinates.x-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Column coordinates of the points specified by the user.

TangentsTangentsTangentstangentstangents (output_control)  real-array HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Tangents specified by the user.

Result

draw_nurbs_interp_moddraw_nurbs_interp_modDrawNurbsInterpModDrawNurbsInterpModdraw_nurbs_interp_mod returns 2 ( H_MSG_TRUE) , if the window is valid. If necessary, an exception is raised.

Possible Predecessors

open_windowopen_windowOpenWindowOpenWindowopen_window

Possible Successors

set_coloredset_coloredSetColoredSetColoredset_colored, set_line_widthset_line_widthSetLineWidthSetLineWidthset_line_width, set_drawset_drawSetDrawSetDrawset_draw, set_insertset_insertSetInsertSetInsertset_insert

Alternatives

draw_xld_moddraw_xld_modDrawXldModDrawXldModdraw_xld_mod, draw_nurbs_moddraw_nurbs_modDrawNurbsModDrawNurbsModdraw_nurbs_mod

See also

draw_nurbs_interpdraw_nurbs_interpDrawNurbsInterpDrawNurbsInterpdraw_nurbs_interp, gen_contour_nurbs_xldgen_contour_nurbs_xldGenContourNurbsXldGenContourNurbsXldgen_contour_nurbs_xld

Module

Foundation