Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/documentation/window_geometry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# window_geometry

::: src.cadwork.window_geometry
rendering:
show_root_heading: true
show_source: true
170 changes: 26 additions & 144 deletions docs/release_notes.md
Original file line number Diff line number Diff line change
@@ -1,191 +1,73 @@
# change log build 30.498.0

## New Items

### Functions dimension_controller

#### get_segment_direction

```python
def get_segment_direction(element: int, segment_index: int) ->point_3d:
"""get segment direction

Parameters:
element: element
segment_index: segment_index

Returns:
point_3d
"""

```

## New Items

### Functions element_controller

#### create_truncated_cone_beam_points
#### unjoin_elements

```python
def create_truncated_cone_beam_points(start_diameter: float, end_diameter:
float, p1: point_3d, p2: point_3d, p3: point_3d) ->int:
"""create truncated cone beam points
def unjoin_elements(element_id_list: List[int]) ->bool:
"""unjoin elements

Parameters:
start_diameter: start_diameter
end_diameter: end_diameter
p1: p1
p2: p2
p3: p3
element_id_list: element_id_list

Returns:
int
bool
"""

```

#### create_truncated_cone_beam_vectors
#### unjoin_top_level_elements

```python
def create_truncated_cone_beam_vectors(start_diameter: float, end_diameter:
float, length: float, p1: point_3d, xl: point_3d, zl: point_3d) ->int:
"""create truncated cone beam vectors
def unjoin_top_level_elements(element_id_list: List[int]) ->bool:
"""unjoin top level elements

Parameters:
start_diameter: start_diameter
end_diameter: end_diameter
length: length
p1: p1
xl: xl
zl: zl
element_id_list: element_id_list

Returns:
int
bool
"""

```

#### create_spline_line

```python
def create_spline_line(spline_points: None) ->int:
"""create spline line

Parameters:
spline_points: spline_points

Returns:
int
"""

```

## New Items

### Functions utility_controller

#### get_user_int_with_default_value
#### set_element_group_single_select_mode

```python
def get_user_int_with_default_value(message: str, default_value: int) ->int:
"""get user int with default value

Parameters:
message: message
default_value: default_value
def set_element_group_single_select_mode() ->None:
"""set element group single select mode

Returns:
int
None
"""

```

#### get_user_double_with_default_value
#### set_element_group_multi_select_mode

```python
def get_user_double_with_default_value(message: str, default_value: float
) ->float:
"""get user double with default value

Parameters:
message: message
default_value: default_value
def set_element_group_multi_select_mode() ->None:
"""set element group multi select mode

Returns:
float
None
"""

```

#### get_user_string_with_default_value
## New Items
### Functions visualization_controller
#### enter_working_plane

```python
def get_user_string_with_default_value(message: str, default_value: str) ->str:
"""get user string with default value
def enter_working_plane(plane_normal: point_3d, plane_origin: point_3d) ->None:
"""enter working plane

Parameters:
message: message
default_value: default_value
plane_normal: plane_normal
plane_origin: plane_origin

Returns:
str
None
"""

```

## New Items

### Classes cadwork

#### multi_layer_type

```python
@unique
class multi_layer_type(IntEnum):
"""multi layer type

Examples:
>>> cadwork.multi_layer_type.undefined
undefined
"""
undefined = 0
""""""
structure = 1
""""""
panel = 2
""""""
lathing = 3
""""""
air = 4
""""""
covering = 5
""""""

def __int__(self) ->int:
return self.value

```

## New Items

### Classes cadwork

#### ifc_2x3_element_type

```python
class ifc_2x3_element_type:
def is_ifc_element_assembly(self) ->bool:
"""is ifc element assembly

Returns:
bool
"""

def set_ifc_element_assembly(self) ->None:
"""set ifc element assembly

Returns:
None
"""

```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ nav:
- Camera: documentation/camera_data.md
- Layer Settings: documentation/layer_settings.md
- Text Object Options: documentation/text_object_options.md
- Window Geometry: documentation/window_geometry.md
- Connector Axis Controller: documentation/connector_axis_controller.md
- Dimension Controller: documentation/dimension_controller.md
- Element Controller: documentation/element_controller.md
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "cwapi3d"
version = "30.498.0"
version = "30.0.533"
authors = [{ name = "Cadwork", email = "it@cadwork.ca" }]
requires-python = ">= 3.10"
description = 'Python bindings for CwAPI3D'
Expand Down
14 changes: 12 additions & 2 deletions src/cadwork/point_3d.pyi
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
class point_3d:
def __init__(self, x: float, y: float, z: float):
"""
Initialize an instance of a point_3d.

Parameters:
x (float): The x-coordinate of the point.
y (float): The y-coordinate of the point.
z (float): The z-coordinate of the point.
"""
self.x = x
self.y = y
self.z = z

def __init__(self, x: float, y: float, z: float) -> None: ...

def dot(self, p: 'point_3d') -> float:
"""dot

Expand Down
4 changes: 2 additions & 2 deletions src/cadwork/projection_type.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ class projection_type(IntEnum):
>>> cadwork.projection_type.Perspective
Perspective
"""
Perspective = 1
Perspective = 0
""""""
Orthographic = 2
Orthographic = 1
""""""

def __int__(self) -> int:
Expand Down
42 changes: 23 additions & 19 deletions src/cadwork/window_geometry.pyi
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
class point:
def __init__(self, x, y):
class Point:
def __init__(self, x: float, y: float):
"""
Initialize a point with x and y coordinates.

Args:
x (float): The x-coordinate.
y (float): The y-coordinate.
"""
self.x = x
self.y = y

class window_geometry:
def __init__(self):
self.bottom_left = self.point(0, 0)
self.bottom_right = self.point(0, 0)
self.top_left = self.point(0, 0)
self.top_right = self.point(0, 0)

@property
def bottom_left(self) -> point: ...

@property
def bottom_right(self) -> point: ...

@property
def top_left(self) -> point: ...
class WindowGeometry:
def __init__(self, bottom_left: Point, bottom_right: Point, top_left: Point, top_right: Point):
"""
Initialize window geometry with points defining the window corners.

@property
def top_right(self) -> point: ...
Args:
bottom_left (Point): The bottom left corner of the window.
bottom_right (Point): The bottom right corner of the window.
top_left (Point): The top left corner of the window.
top_right (Point): The top right corner of the window.
"""
self.bottom_left = bottom_left
self.bottom_right = bottom_right
self.top_left = top_left
self.top_right = top_right
Loading