Metadata-Version: 2.4
Name: TurtleGL-3d
Version: 1.2.3
Summary: A 3D grafics library based on turtle
Home-page: https://github.com/MichaelHyan/turtleGL
Author: Han Yan
Author-email: Han Yan <3367461801@qq.com>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/MichaelHyan/turtleGL
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24.4
Requires-Dist: opencv-python>=4.12.0
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

## turtleGL-3d

### A 3D Drawing Library based on the turtle library

### Install

```
pip install TurtleGL-3d
```

### Data Structure

Implemented using separate camera objects and scene objects.

Scene objects can store data within themselves and can be specified and invoked by camera objects.

Multiple cameras can be used for flexible switching.

#### Camera Attributes

You can directly reassign values to the attributes of the camera object.

```python
camera_position# Camera position [x,y,z], positive up direction is [0,0,1]
camera_direction# Camera facing direction [x,y,z]
camera_rotation# Camera rotation angle, specifically manifested as left/right tilt, using radians
camera_focal# Camera focal length
point_behind_cam_type# Back point handling 0/1/2
ray# Light ray direction, used to determine if a face is facing the light source
rend# Render type 0 Material preview 1 Shadow mode 2 Normal preview
shade_value# Multiply coefficient 0-255
pensize# Pen size, effective only for lines
pencolor# Pen color, effective only for lines
type# Camera type 0 Cabinet projection 1 Perspective projection 2 Isometric projection -1 Orthographic projection
```

In point mapping calculations, points behind the camera cannot be calculated normally; three handling logics are provided:

0: No handling, back points will appear in the opposite direction

1: Flip UV, turning the point back to the normal direction

2: Switch to using orthographic mode, deviation is relatively smaller than the previous two

##### Material Preview Mode

Faces directly display the specified color.

##### Shadow Mode

This project does not currently support stable rasterization algorithms, so light ray calculations do not exist.

After enabling shadow mode, face data will calculate whether it belongs to a lit surface based on the angle between the light ray direction and the normal. If not, the multiply coefficient is used to recalculate the surface color.

##### Normal Mode

Displays normals. When the cosine value between the camera direction and the face normal is greater than 0 (i.e., an obtuse angle), it is determined as the front face and displayed in blue; otherwise, it is displayed in red.

##### Image Export

Since turtle itself does not have image capture functionality, the following methods can be used to store single-frame images.

```python
# Drawing area initialization before screenshot
camera.image_size = [500,400]
camera.create_image('hex background color')# Can be called repeatedly to achieve clear screen effect

# Drawing
camera.draw_from_scene_cv2(scene object data)# Temporarily store current frame image after use

# Export
camera.imwrite('filename')

# Video processing
# Screenshot by sequence number
camera.capture('name', current index)# Store to .\filename\index:08d.png
# Compose video
camera.to_video('name')
```

#### Camera Methods

```python
setposition([x,y,z])# Set camera position, can also directly set camera_position attribute
setdirection([x,y,z])# Set camera direction, can also directly set camera_direction attribute
setfocal(x):# Set camera focal length, can also directly set camera_focal attribute
settype(x):# Set camera type, can also directly set type attribute
status()# Output current camera attributes
tracer(0)# Turn off animation, operate turtle directly
to_target([x,y,z])# Set camera to face target point
pointfocal([x,y,z])# In perspective mode, return coordinates mapped from space to camera
pointcabinet([x,y,z])# In cabinet mode, return coordinates mapped from space to camera
draw_axis(l)# Draw reference coordinate axes, l adjusts size
dot([x, y, z], optional color) # Draw a single point, the size is determined by pensize
drawline(linedata)# Input single edge data, draw edge
drawface(facedata)# Input single face coordinates, draw face
draw_from_scene(scenedata)# Input integrated data, draw all
delay()# Delay, same effect as turtle.delay()
clear()# Clear canvas, same effect as turtle.clear()
bgcolor()# Canvas background color, same effect as turtle.bgcolor()
update()# Update canvas, same effect as turtle.update()
done()# Prevent automatic window closing, same effect as turtle.done()
```

#### Scene Attributes

The scene contains line and face attributes, storing edge/face data.

Multiple scene objects can be used.

##### Data Format

```python
[
    [
        [point1],
        [point2],
        ...
        [pointn]
    ],
    'hexadecimal color'
]
```

When the number of points is 2, it will be recognized as an edge.

When using face data, the direction of the normal ray is considered positive, and points are input in a counter-clockwise direction.

The line and face attributes of the scene object are arrays containing the above data; each element is separate line/face data and can be directly called or modified.

#### Scene Methods

```python
addline([[x1,y1,z1],[x2,y2,z2],'hex color'])# Add edge
addface([[x1,y1,z1],[x2,y2,z2],...,[xn,yn,zn],'hex color'])# Add face
export_line(path)# Export line data csv
export_face(path)# Export face data csv
import_line(path)# Import line data
import_face(path)# Import face data
scene.rotate_edge()# Iterate over edges, used to generate different triangulations
sort_line_avg([camera x, camera y, camera z])# Adjust layer order in perspective or orthographic mode, modify scene object attributes and return adjusted data
sort_face_avg([camera x, camera y, camera z])# Adjust layer order in perspective or orthographic mode, modify scene object attributes and return adjusted data
sort_all_avg([camera x, camera y, camera z])# Return all adjusted data, does not modify scene object attributes
sort_line_cabin()# Adjust layer order in cabinet mode, modify scene object attributes and return adjusted data
sort_face_cabin()# Adjust layer order in cabinet mode, modify scene object attributes and return adjusted data
sort_all_cabin()# Return all adjusted data, does not modify scene object attributes
sort_line_isometric()# Adjust layer order in isometric mode, modify scene object attributes and return adjusted data
sort_face_isometric()# Adjust layer order in isometric mode, modify scene object attributes and return adjusted data
sort_all_isometric()# Return all adjusted data, does not modify scene object attributes
reverse_normvect(i)# Modify the normal direction of the i-th face data
import_obj(path, scale factor, color)# Import obj model, random color if color is empty
check_obj_norm(path)# Correct normal direction according to obj file information
scene.generate_obj_line(color)# Generate edges based on face data
```

##### Adjusting Order

This project does not currently support stable rasterization algorithms, so light ray calculations do not exist.

The front/back order of faces is determined by the layer and rendering order.

##### obj Model

Acts directly on scene.face after import. Only one object can be imported at a time, and the object name must be in English.

#### 3D Function Graphs

Similar to scene object operations, but data generation depends on the target function.

Includes line and face data, drawing range, and sampling step.

##### Function Methods

Assume the function is defined as follows:

```python
def func(x,y):
    # Unknown operations
    return z
```

Set the domain (drawing range):

```python
scene.xlim = [x1,x2] # Indicates sampling from x1 until x2
scene.ylim = [y1,y2] # Indicates sampling from y1 until y2
scene.step = d # Sampling step
```

Generate graph:

```python
scene.generate_face(func)
scene.generate_line(func)
```

Other operations are consistent with scene objects.

#### Volume Properties

Using a volume object, individual scene face data can be assigned to a volume object for separate calculation from the scene data.

Volume calculation uses the ray casting method and is intended for use only with closed shapes composed purely of triangles.

The volume calculation returns all points located within the shape within the sampling grid.

```python
points          # Number, contains the calculated points
sample_distance # Sampling grid spacing (sampling distance)
grid_limit      # Partition acceleration algorithm limit, defaults to positive infinity; enabled when the number of triangles exceeds this value
check           # Boolean, whether to enable multi-directional check
allow_edge      # Boolean, whether to include boundary intersection points
```

The use of the partition acceleration algorithm is not recommended, as it may produce incorrect results in calculations for irregular shapes; it functions correctly only for convex polyhedra.

#### Volume Methods

```
volume(scene_face_data) # Returns all internal points and simultaneously stores them in the points attribute
```

##### Operation Flow

1. Instantiate camera object
2. Adjust lens attributes
3. Instantiate scene object
4. Add data to scene object
5. Sort scene object data
6. Use camera object to invoke data
7. Draw

### Test Feature: Rasterization Algorithm

This feature is not yet stable and is for reference only.

```python
scene.triangulation()# Face triangulation, currently raster mode can only handle triangular faces
camera.grating_size = [x,y]# Rendering area size
camera.show_grating_limit()# Display rendering area edges
camera.grating(face)# Calculate using rasterization algorithm
```

When render mode is 1, shadow mode is no longer used; instead, light ray paths are calculated.

### Usage (Example)

#### Camera Object

Set camera attributes.

```python
camera = turtleGL.camera()# Instantiate camera object
camera.camera_position = [-101,-121,131]# Camera position
camera.camera_direction = [1,1,-1]# Camera direction
camera.to_target([0,0,0])# Camera looks at target point
camera.camera_focal = 300# Focal length
camera.ray = [1,1,-1]# Light direction
camera.type = 1# 1 Perspective mode  0 Cabinet mode
camera.rend = 1# 0 Material preview 1 Shadow 2 Normal
camera.status()# View camera attributes
camera.grating_size = [500,400]# Raster mode set rendering area size
camera.image_size = [500,400]# Export image size
camera.image # Current stored image
```

#### Scene Object

Use structured data to store scene information, divided into lines and faces, directly stored in the scene object and can be invoked.

```python
scene = turtleGL.scene()# Instantiate scene
# Custom edge information
scene.line = [[[[50.0, 50.0, 0.0], [-50.0, 50.0, 0.0]], '#000000'], 
              [[[-50.0, 50.0, 0.0], [-50.0, -50.0, 0.0]], '#000000'], 
              [[[-50.0, -50.0, 0.0], [50.0, -50.0, 0.0]], '#000000'], 
              [[[50.0, -50.0, 0.0], [50.0, 50.0, 0.0]], '#000000'], 
              [[[50.0, 50.0, 100.0], [-50.0, 50.0, 100.0]], '#000000'], 
              [[[-50.0, 50.0, 100.0], [-50.0, -50.0, 100.0]], '#000000'], 
              [[[-50.0, -50.0, 100.0], [50.0, -50.0, 100.0]], '#000000'], 
              [[[50.0, -50.0, 100.0], [50.0, 50.0, 100.0]], '#000000'], 
              [[[50.0, 50.0, 0.0], [50.0, 50.0, 100.0]], '#000000'], 
              [[[-50.0, 50.0, 0.0], [-50.0, 50.0, 100.0]], '#000000'], 
              [[[-50.0, -50.0, 0.0], [-50.0, -50.0, 100.0]], '#000000'], 
              [[[50.0, -50.0, 0.0], [50.0, -50.0, 100.0]], '#000000']]
# Custom face information
scene.face = [[[[50.0, 50.0, 0.0], [-50.0, 50.0, 0.0], [-50.0, -50.0, 0.0], [50.0, -50.0, 0.0]], '#FF0000'], 
              [[[50.0, 50.0, 0.0], [50.0, 50.0, 100.0], [50.0, -50.0, 100.0], [50.0, -50.0, 0.0]], '#0000FF'], 
              [[[-50.0, 50.0, 0.0], [-50.0, -50.0, 0.0], [-50.0, -50.0, 100.0], [-50.0, 50.0, 100.0]], '#FFFF00'], 
              [[[50.0, 50.0, 0.0], [-50.0, 50.0, 0.0], [-50.0, 50.0, 100.0], [50.0, 50.0, 100.0]], '#FF00FF'], 
              [[[50.0, 50.0, 100.0], [-50.0, 50.0, 100.0], [-50.0, -50.0, 100.0], [50.0, -50.0, 100.0]], '#00FF00'], 
              [[[-50.0, -50.0, 0.0], [50.0, -50.0, 0.0], [50.0, -50.0, 100.0], [-50.0, -50.0, 100.0]], '#00FFFF']]
```

Organize display order (taking perspective mode as an example)

```python
scene.sort_line_avg(camera.camera_position)# Edges only
scene.sort_face_avg(camera.camera_position)# Faces only
scene.sort_all_avg(camera.camera_position)# Organize all, directly return structured data, does not modify object
```

Draw

```python
camera.draw_from_scene(scene.sort_all_avg(camera.camera_position))# Draw all content
camera.draw_from_scene(scene.line)# Draw edges only
camera.draw_from_scene(scene.face)# Draw faces only
camera.draw_axis(10)# Show axes
camera.done()
```

Import/Export

```python
# Export
scene.export_line('example_line.csv')
scene.export_face('example_face.csv')
# Import
scene.import_line('example_line.csv')
scene.import_face('example_face.csv')
```
