Skip to content
This repository was archived by the owner on May 19, 2025. It is now read-only.

Commit b142d82

Browse files
committed
Update function reference and contribution docs
1 parent b6077fd commit b142d82

File tree

2 files changed

+40
-90
lines changed

2 files changed

+40
-90
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,9 @@ I would like to introduce some rules on contributing to this module.
2727

2828
#### Naming conventions in the Python module
2929

30-
* Python objects are defined as `ACIS_{ModuleName}_{ACISName}` and located in the header files
31-
* Type functions are defined as `ACIS_{ModuleName}_{function_name}_{ACISName}`, e.g. _a3dp_init_SPAposition_
32-
* Methods for types are defined as `ACIS_{ModuleName}_method_{ACISName}_{MethodName}`, e.g. _a3dp_method_ENTITY_LIST_add_ which corresponds to _ENTITY_LIST::add()_ on the C++ side
33-
* Module variables are defined as `ACIS_{ModuleName}_{function_name}`, e.g. _ACIS_Topology_module_
34-
* Module init functions are defined as `PyInit_{ModuleName}`
35-
* ACIS API calls are defined as `ACIS_{API Call}`, e.g. _ACIS_api_start_modeller_ which corresponds to _api_start_modeller()_ on the C++ side
30+
* Type functions: `a3dp_{ACISName}_{function_name}`, e.g. _a3dp_SPAposition_init_ which corresponds to Python's _tp_init_ function.
31+
* Methods for types: `a3dp_{ACISName}__{MethodName}`, e.g. _a3dp_ENTITY_LIST__add_ which corresponds to _ENTITY_LIST::add()_ on the C++ side
32+
* ACIS API calls: `a3dp_{API-Call}`, e.g. _a3dp_api_start_modeller_ which corresponds to _api_start_modeller()_ on the C++ side
3633

3734
### Contribution in general
3835

FUNCTION_REFERENCE.md

Lines changed: 37 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
**Note:** Some class methods might be missing. Please see [CONTRIBUTING](CONTRIBUTING.md) file for details.
44

5-
## Modeler
6-
7-
### Functions
5+
## API Calls
86

7+
* spa_unlock_products
98
* api_start_modeller (api_start_modeler)
109
* api_stop_modeller (api_stop_modeler)
1110
* is_modeler_started
@@ -22,42 +21,6 @@
2221
* api_apply_transf
2322
* api_remove_transf
2423
* api_sheet_from_ff
25-
26-
## Entity
27-
28-
### Classes
29-
30-
* ENTITY
31-
* BODY
32-
* LUMP
33-
* SHELL
34-
* SUBSHELL
35-
* FACE
36-
* EDGE
37-
* COEDGE
38-
* VERTEX
39-
* WIRE
40-
* SURFACE
41-
* CONE
42-
* PLANE
43-
* SPHERE
44-
* SPLINE
45-
* TORUS
46-
47-
## Geometric Atoms
48-
49-
### Classes
50-
51-
* SPAposition
52-
* SPAtransf
53-
* SPAmatrix
54-
* SPAvector
55-
* SPAunit_vector
56-
* SPApar_pos
57-
* SPApar_vec
58-
59-
### Functions
60-
6124
* coordinate_transf
6225
* make_transf
6326
* reflect_transf
@@ -78,63 +41,53 @@
7841
* get_resnor
7942
* distance_to_point
8043
* distance_to_point_squared
81-
82-
## Lists
83-
84-
### Classes
85-
86-
* ENTITY_LIST
87-
88-
## Query
89-
90-
### Functions
91-
9244
* get_owner_transf
9345
* api_get_faces
9446
* api_get_edges
95-
96-
## Save & Restore
97-
98-
### Classes
99-
100-
* FileInfo
101-
102-
### Functions
103-
10447
* api_save_entity_list
10548
* api_set_file_info
10649
* api_get_file_info
10750
* api_save_version
108-
109-
## Sweeping
110-
111-
### Classes / Enums
112-
113-
* sweep_bool_type
114-
* sweep_options
115-
* make_sweep_path_options
116-
117-
### Functions
118-
51+
* api_unite
52+
* api_intersect
53+
* api_subtract
54+
* api_imprint
55+
* api_boolean_chop_body
11956
* api_make_sweep_path
12057
* api_sweep_with_options
12158

122-
## Licensing
123-
124-
### Functions
12559

126-
* spa_unlock_products
60+
## Classes
12761

128-
## Booleans
62+
* ENTITY
63+
* BODY
64+
* LUMP
65+
* SHELL
66+
* SUBSHELL
67+
* FACE
68+
* EDGE
69+
* COEDGE
70+
* VERTEX
71+
* WIRE
72+
* SURFACE
73+
* CONE
74+
* PLANE
75+
* SPHERE
76+
* SPLINE
77+
* TORUS
78+
* ENTITY_LIST
79+
* SPAposition
80+
* SPAtransf
81+
* SPAmatrix
82+
* SPAvector
83+
* SPAunit_vector
84+
* SPApar_pos
85+
* SPApar_vec
86+
* FileInfo
87+
* sweep_options
88+
* make_sweep_path_options
12989

130-
### Enums
90+
## Enums
13191

92+
* sweep_bool_type
13293
* NDBOOL_KEEP
133-
134-
### Functions
135-
136-
* api_unite
137-
* api_intersect
138-
* api_subtract
139-
* api_imprint
140-
* api_boolean_chop_body

0 commit comments

Comments
 (0)