Skip to content

Dimension Controller

add_segment(element, segment)

adds a segment to a dimension element

Parameters:

Name Type Description Default
element int

element

 required
segment point_3d

segment

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
29
30
31
32
33
34
35
36
37
38
def add_segment(element: int, segment: point_3d) -> None:
    """adds a segment to a dimension element

    Parameters:
        element: element
        segment: segment

    Returns:
        None
    """

create_dimension(xl, plane_normal, distance, dimension_points)

creates a dimension element

Parameters:

Name Type Description Default
xl point_3d

xl

 required
plane_normal point_3d

plane_normal

 required
distance point_3d

distance

 required
dimension_points List[point_3d]

dimension_points

 required

Returns:

Type Description
int

elementID of created dimension element
Source code in src/dimension_controller/__init__.pyi 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
def create_dimension(xl: point_3d, plane_normal: point_3d, distance: point_3d, dimension_points: List[point_3d]) -> int:
    """creates a dimension element

    Parameters:
        xl: xl
        plane_normal: plane_normal
        distance: distance
        dimension_points: dimension_points

    Returns:
        elementID of created dimension element
    """

get_default_anchor_length(element)

gets the default anchor length

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
float

double
Source code in src/dimension_controller/__init__.pyi 
149
150
151
152
153
154
155
156
157
def get_default_anchor_length(element: int) -> float:
    """gets the default anchor length

    Parameters:
        element: element

    Returns:
        double
    """

get_dimension_points(element)

gets all dimension points ordered by dimension direction

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
List[point_3d]

ICwAPI3DVertexList
Source code in src/dimension_controller/__init__.pyi 
139
140
141
142
143
144
145
146
147
def get_dimension_points(element: int) -> List[point_3d]:
    """gets all dimension points ordered by dimension direction

    Parameters:
        element: element

    Returns:
        ICwAPI3DVertexList
    """

get_distance(element)

Get the distance to the dimension reference point. The point is in the plane of the dimensioning.

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
point_3d

point_3d
Source code in src/dimension_controller/__init__.pyi 
161
162
163
164
165
166
167
168
169
def get_distance(element: int) -> point_3d:
    """Get the distance to the dimension reference point. The point is in the plane of the dimensioning.

    Parameters:
        element: element

    Returns:
        point_3d
    """

get_plane_normal(element)

Get the plane normal

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
point_3d

normal
Source code in src/dimension_controller/__init__.pyi 
171
172
173
174
175
176
177
178
179
def get_plane_normal(element: int) -> point_3d:
    """Get the plane normal

    Parameters:
        element: element

    Returns:
        normal
    """

get_plane_xl(element)

Get the plane x direction

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
point_3d

x direction
Source code in src/dimension_controller/__init__.pyi 
181
182
183
184
185
186
187
188
189
def get_plane_xl(element: int) -> point_3d:
    """Get the plane x direction

    Parameters:
        element: element

    Returns:
        x direction
    """

get_segment_count(element)

Get count of segments

Parameters:

Name Type Description Default
element int

element

 required

Returns:

Type Description
int

segment count
Source code in src/dimension_controller/__init__.pyi 
191
192
193
194
195
196
197
198
199
def get_segment_count(element: int) -> int:
    """Get count of segments

    Parameters:
        element: element

    Returns:
        segment count
    """

get_segment_distance(element, segment_index)

Get the distance from the anchor point to the dimension segment

Parameters:

Name Type Description Default
element int

element

 required
segment_index int

segment_index

 required

Returns:

Type Description
float

distance
Source code in src/dimension_controller/__init__.pyi 
201
202
203
204
205
206
207
208
209
210
def get_segment_distance(element: int, segment_index: int) -> float:
    """Get the distance from the anchor point to the dimension segment

    Parameters:
        element: element
        segment_index: segment_index

    Returns:
        distance
    """

set_default_anchor_length(elements, length)

sets the default anchor length a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
length float

length

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
106
107
108
109
110
111
112
113
114
115
def set_default_anchor_length(elements: List[int], length: float) -> None:
    """sets the default anchor length a dimension element

    Parameters:
        elements: elements
        length: length

    Returns:
        None
    """

set_distance(elements, distance)

sets the distance vector between the points and the line

Parameters:

Name Type Description Default
elements List[int]

elements

 required
distance point_3d

distance

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
117
118
119
120
121
122
123
124
125
126
def set_distance(elements: List[int], distance: point_3d) -> None:
    """sets the distance vector between the points and the line

    Parameters:
        elements: elements
        distance: distance

    Returns:
        None
    """

set_line_color(elements, color_id)

sets the line color a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
color_id int

color_id

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
 95
 96
 97
 98
 99
100
101
102
103
104
def set_line_color(elements: List[int], color_id: int) -> None:
    """sets the line color a dimension element

    Parameters:
        elements: elements
        color_id: color_id

    Returns:
        None
    """

set_line_thickness(elements, thickness)

sets the line thickness a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
thickness float

thickness

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
62
63
64
65
66
67
68
69
70
71
def set_line_thickness(elements: List[int], thickness: float) -> None:
    """sets the line thickness a dimension element

    Parameters:
        elements: elements
        thickness: thickness

    Returns:
        None
    """

set_orientation(elements, view_dir, view_dir_up)

sets the orientation of a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
view_dir point_3d

view_dir

 required
view_dir_up point_3d

view_dir_up

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
17
18
19
20
21
22
23
24
25
26
27
def set_orientation(elements: List[int], view_dir: point_3d, view_dir_up: point_3d) -> None:
    """sets the orientation of a dimension element

    Parameters:
        elements: elements
        view_dir: view_dir
        view_dir_up: view_dir_up

    Returns:
        None
    """

set_precision(elements, precision)

sets the precision/decimal places of a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
precision int

precision

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
40
41
42
43
44
45
46
47
48
49
def set_precision(elements: List[int], precision: int) -> None:
    """sets the precision/decimal places of a dimension element

    Parameters:
        elements: elements
        precision: precision

    Returns:
        None
    """

set_text_color(elements, color_id)

sets the text color a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
color_id int

color_id

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
84
85
86
87
88
89
90
91
92
93
def set_text_color(elements: List[int], color_id: int) -> None:
    """sets the text color a dimension element

    Parameters:
        elements: elements
        color_id: color_id

    Returns:
        None
    """

set_text_size(elements, text_size)

sets the text size a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
text_size float

text_size

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
51
52
53
54
55
56
57
58
59
60
def set_text_size(elements: List[int], text_size: float) -> None:
    """sets the text size a dimension element

    Parameters:
        elements: elements
        text_size: text_size

    Returns:
        None
    """

set_total_dimension(elements, total)

sets if the total dimension is shown in a dimension element

Parameters:

Name Type Description Default
elements List[int]

elements

 required
total bool

total

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
73
74
75
76
77
78
79
80
81
82
def set_total_dimension(elements: List[int], total: bool) -> None:
    """sets if the total dimension is shown in a dimension element

    Parameters:
        elements: elements
        total: total

    Returns:
        None
    """

shift_distance_and_texts(elements, shifted)

sets if distance and texts are shifted

Parameters:

Name Type Description Default
elements List[int]

elements

 required
shifted bool

shifted

 required

Returns:

Type Description
None

None
Source code in src/dimension_controller/__init__.pyi 
128
129
130
131
132
133
134
135
136
137
def shift_distance_and_texts(elements: List[int], shifted: bool) -> None:
    """sets if distance and texts are shifted

    Parameters:
        elements: elements
        shifted: shifted

    Returns:
        None
    """