NDEVR
API Documentation
CrossSectionModel.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Design
28File: DrillPattern
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/Model.h>
34#if NDEVR_CROSS_SECTION
35namespace NDEVR
36{
37 struct SlicerArgs;
38 struct ParameterSlicerArgs;
40 class JSONNode;
41
46 class NDEVR_DESIGN_API CrossSectionModel : public Model
47 {
48 public:
52 CrossSectionModel();
53
58 CrossSectionModel(const Model& root);
59
64 void executeCrossSection(SlicerArgs& args);
65
70 void executeCrossSection(ParameterSlicerArgs& args);
71
76 Model pathRoot();
77
82 bool hasPath() const;
83
88 void setCenterlineRange(const Vector<2, fltp08>& range);
89
94 void setOrthogonalSpacing(const Vector<3, fltp08>& spacing);
95
100 void setUseParallelVertical(bool use);
101
106 void setUseParallelHorizontal(bool use);
107
112 void setUseOrthogonal(bool use);
113
118 void setUseVerticalOrthogonal(bool use);
119
124 bool useParallelVertical() const;
125
130 bool useParallelHorizontal() const;
131
136 bool useOrthogonal() const;
137
142 bool useVerticalOrthogonal() const;
143
148 Vector<3, fltp08> spacing() const;
149
154 Vector<2, fltp08> centerlineRange() const;
155
160 static constexpr StringView TypeName() { return "cross_section"; }
161
166 static constexpr StringView CrossSectionPath() { return "cross_section_path"; }
167
172 static constexpr StringView ParallelVerticalUsageLabel() { return "use_parallel_vertical"; }
173
178 static constexpr StringView ParallelHorizontalUsageLabel() { return "use_parallel_horizontal"; }
179
184 static constexpr StringView OrthogonalUsageLabel() { return "use_orthogonal"; }
185
190 static constexpr StringView VerticalOrthogonalUsageLabel() { return "use_vertical_orthogonal"; }
191 protected:
195 void init();
196
201 void initCache(DesignObjectResourceCache& resource_cache);
202
207 void deInitCache(DesignObjectResourceCache& resource_cache);
208 };
209}
210#endif
A cache for reusing Model and Geometry objects to avoid repeated allocation.
JavaScript Object Notation or JSON is an open - standard file format that uses human - readable text ...
Definition JSONParser.h:149
A core class that represents a node on model hierarchy.
Definition Model.h:292
The primary namespace for the NDEVR SDK.
Arguments for performing a Geometry slice operation.