formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Plain Object Construction

# fz_objt_cnstr_dimn_linr

Description

Constructs a linear dimension, given a plane and two points on the plane. The x axis of the plane determines the direction along which the linear dimension is measured. The two points can be defined explicitely, via the fz_xyz_td argument or through the obj and pindx argments (If the fz_xyz_td* argument is NULL). Using obj and pindx also creates an associative diemnsion point. The offset parameter determines how far from point1 the dimension line is displayed. It is measured along the posituve y axis of the plane. It may be negative to make is show up on the offposite side. The dimension style is optionally defined by the style_tag argument. If passed as NULL, the current style is used. If the cust_str is passed as non NULL, it is used as a custom string.It must contain the "<>" characters for the actual dimension value to be displayed (as in the user interface). user interface).

Plugin Prototype

fzrt_error_td fz_objt_cnstr_dimn_linr(

fzrt_int | windex,
fz_map_plane_td * | plane,
fz_xyz_td * | p1,
fz_objt_ptr | obj1,
fzrt_int | pindx1,
fz_xyz_td * | p2,
fz_objt_ptr | obj2,
fzrt_int | pindx2,
double | offset,
fz_diml_text_align_enum | text_align,
fz_tag_td * | style_tag,
fz_string_td | cust_str,
fz_objt_ptr * | new_obj )

Parameters

windex [Input]

project window index

plane [Input]

Plane in which the dimension exists. The X axis of the plane is the direction alogn which the dimension is measured and therefore the direction in which the dimension line is drawn. The y axis defines the positive offset of the dimension line.

p1 [Input]

First dimension point, or NULL (in which case obj1 and pindx1 must be defined)

obj1 [Input]

Object for first dimension point (Must be non NULL, if p1 is NULL)

pindx1 [Input]

Point index for first dimension point (Must be non NULL, if p1 is NULL)

p2 [Input]

Second dimension point, or NULL (in which case obj2 and pindx2 must be defined)

obj2 [Input]

Object for second dimension point (Must be non NULL, if p2 is NULL)

pindx2 [Input]

Point index for second dimension point (Must be non NULL, if p2 is NULL)

offset [Input]

Dimension line offset along Y axis of plane

text_align [Input]

Text alignment

style_tag [Input, Optional]

Tag of the dimension style to be used. If NULL is passed, the default style will be used.

cust_str [Input, Optional]

Custom string, as in the user interface.

new_obj [Result]

The new dimension object.

Returns

Error codes

Availability

7.0.0.0

Function Set

fz_model_fset

Defined in

fz_objt_api.h