NDEVR
API Documentation
CADEntityStreamer.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: CAD
28File: CADEntityStreamer
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "CADEntities.h"
34#include "DXFAttributes.h"
35#include <NDEVR/Log.h>
36#include <NDEVR/Translator.h>
37#include <NDEVR/TranslatedString.h>
38namespace NDEVR
39{
40 class DXFValueManager;
44 class CADEntityStreamer
45 {
46 public:
47 CADEntityStreamer(ProgressInfo& logger)
48 : m_log_features(false)
49 , m_logger(logger)
50 {}
51 virtual ~CADEntityStreamer() = default;
52 virtual void processCodeValuePair(unsigned int, const String&) {/*if(m_log_features) m_logger.addMessage("Code Value Pair");*/ }
53 virtual void endSection() { if (m_log_features) m_logger.addMessage(_t("End Section")); }
54 virtual void addLayer(const LayerData&) { if (m_log_features) m_logger.addMessage(_t("Add Layer")); }
55 virtual void addLinetype(const LineTypeData&) { if (m_log_features) m_logger.addMessage(_t("Add Line Type")); }
56 virtual void addLinetypeDash(double) { if (m_log_features) m_logger.addMessage(_t("Add Line Type Dash")); }
57 virtual void addBlock(const BlockData&) { if (m_log_features) m_logger.addMessage(_t("Add Block")); }
58 virtual void addGroup(const DXFGroup&) { if (m_log_features) m_logger.addMessage(_t("Add Group")); }
59 virtual void endBlock(const uint04&) { if (m_log_features) m_logger.addMessage(_t("End Block")); }
60 virtual void addTextStyle(const StyleData&) { if (m_log_features) m_logger.addMessage(_t("Add Text Style")); }
61 virtual void addPoint(const PointData&) { if (m_log_features) m_logger.addMessage(_t("Add Point")); }
62 virtual void addLine(const LineData&) { if (m_log_features) m_logger.addMessage(_t("Add Line")); }
63 virtual void addXLine(const LineData&) { if (m_log_features) m_logger.addMessage(_t("Add X Line")); }
64 virtual void addDXFMaterial(DXFMaterial&) { if (m_log_features) m_logger.addMessage(_t("Add Material")); }
65 virtual void addRay(const LineData&) { if (m_log_features) m_logger.addMessage(_t("Add Ray")); }
66 virtual void addAttribute(const Attrib&) { if (m_log_features) m_logger.addMessage(_t("Add Attribute")); }
67 virtual void addAttributeDefinition(const Attrib&) { if (m_log_features) m_logger.addMessage(_t("Add Attribute Definition")); }
68 virtual void addViewport(const ViewportData&) { if (m_log_features) m_logger.addMessage(_t("Add ViewportData")); }
69 virtual void addArc(const ArcData&) { if (m_log_features) m_logger.addMessage(_t("Add Arc")); }
70 virtual void addCircle(const CircleData&) { if (m_log_features) m_logger.addMessage(_t("Add Circle")); }
71 virtual void addEllipse(const EllipseData&) { if (m_log_features) m_logger.addMessage(_t("Add Ellipse")); }
72
73 virtual void addPolyline(const PolylineData&) { if (m_log_features) m_logger.addMessage(_t("Add Polyline")); }
74 virtual void addVertex(const Vector<4, fltp08>&) { if (m_log_features) m_logger.addMessage(_t("Add Vertex")); }
75 virtual void setVertex(uint04, const Vector<4, fltp08>&) { if (m_log_features) m_logger.addMessage(_t("Set Vertex")); }
76 virtual void addIndex(const Vector<4, sint04>&) { if (m_log_features) m_logger.addMessage(_t("Add Index")); }
77
78 virtual void addSpline(const SplineData&) { if (m_log_features) m_logger.addMessage(_t("Add Spline")); }
79 virtual void addControlPoint(const Vector<4, fltp08>&) { if (m_log_features) m_logger.addMessage(_t("Add Control Point")); }
80 virtual void addFitPoint(const Vector<3, fltp08>&) { if (m_log_features) m_logger.addMessage(_t("Add Fit Point")); }
81 virtual void addKnot(fltp08) { if (m_log_features) m_logger.addMessage(_t("Add Knot")); }
82 virtual void addInsert(const BlockInsert&) { m_logger.addMessage(_t("Add Insert")); }
83
84 virtual void addText(const TextData&) { if (m_log_features) m_logger.addMessage(_t("Add Text")); }
85 virtual void addDimAlign(const DimAlignedData&) { if (m_log_features) m_logger.addMessage(_t("Add Dim Align")); }
86 virtual void addDimLinear(const LinearDimension&) { if (m_log_features) m_logger.addMessage(_t("Add Dim Linear")); }
87 virtual void addDimRadial(const RadialDimension&) { if (m_log_features) m_logger.addMessage(_t("Add Dim Radial")); }
88 virtual void addDimDiametric(const DiametricDimension&) { if (m_log_features) m_logger.addMessage(_t("Add Dim Diametric")); }
89 virtual void addDimAngular(const AngularDimensionData<3>&) { if (m_log_features) m_logger.addMessage(_t("Add Dim Angular")); }
90 virtual void addDimAngular(const AngularDimensionData<4>&) { if (m_log_features) m_logger.addMessage(_t("Add Dim Angular 3P")); }
91 virtual void addDimOrdinate(const DimOrdinateData&) { if (m_log_features) m_logger.addMessage(_t("Add Dim Ordinate")); }
92 virtual void addMesh(CADMeshData&) { if (m_log_features) m_logger.addMessage(_t("Add MESH")); }
93 virtual void addLeader(const LeaderData&) { if (m_log_features) m_logger.addMessage(_t("Add Leader")); }
94 virtual void addLeaderVertex(const Vector<2, fltp08>&) { if (m_log_features) m_logger.addMessage(_t("Add Leader Vertex")); }
95
96 virtual void addHatch(const HatchData&) { if (m_log_features) m_logger.addMessage(_t("Add Hatch")); }
97
98 virtual void addTrace(const TraceData&) { if (m_log_features) m_logger.addMessage(_t("Add Trace")); }
99 virtual void add3dFace(const TraceData&) { if (m_log_features) m_logger.addMessage(_t("Add 3D Face")); }
100 virtual void add3dFace(const Triangle<3, fltp08>&) { if (m_log_features) m_logger.addMessage(_t("Add 3D Face")); }
101
102 virtual void addImage(const CADImageData&) { if (m_log_features) m_logger.addMessage(_t("Add Image")); }
103 virtual void linkImage(const ImageDefData&) { if (m_log_features) m_logger.addMessage(_t("Link Image")); }
104 virtual void addHatchLoop(const HatchLoopData&) { if (m_log_features) m_logger.addMessage(_t("Add Hatch Loop")); }
105 virtual void addHatchEdge(const HatchEdgeData&) { if (m_log_features) m_logger.addMessage(_t("Add Hatch Edge")); }
106
107 virtual void addXRecord(const HandleData&) { if (m_log_features) m_logger.addMessage(_t("Add XRecord")); }
108 virtual void addXRecordData(uint04, DXFValueManager*) { if (m_log_features) m_logger.addMessage(_t("Add X Data")); };
109
110 virtual void addDictionary(const CADDictionaryObject&) { if (m_log_features) m_logger.addMessage(_t("Add Dictionary")); }
111 virtual void addDictionaryEntry(const StringView&, const StringView&) { if (m_log_features) m_logger.addMessage(_t("Add Dictionary")); }
112
113 virtual void endEntity() { if (m_log_features) m_logger.addMessage(_t("End Sequence")); }
114
115 virtual void addComment(const StringView&) { if (m_log_features) m_logger.addMessage(_t("End Sequence")); }
116
117 virtual void setVariableVector(const StringView&, Vector<3, fltp08>, int) { if (m_log_features) m_logger.addMessage(_t("End Sequence")); }
118 virtual void setVariableString(const StringView&, const StringView&, int) { if (m_log_features) m_logger.addMessage(_t("End Sequence")); }
119 virtual void setVariableInt(const StringView&, int, int) { if (m_log_features) m_logger.addMessage(_t("End Sequence")); }
120 virtual void setVariableDouble(const StringView&, double, int) { if (m_log_features) m_logger.addMessage(_t("End Sequence")); }
121 virtual void endSequence() { if (m_log_features) m_logger.addMessage(_t("End Sequence")); }
122
123 virtual void setAttributes(const DXFAttributes&) {
124 //m_attributes = attrib;
125 }
126
127
128
129 virtual void setExtrusion(fltp08 dx, fltp08 dy, fltp08 dz, fltp08 elevation) {
130 m_extrusion.setDirection(dx, dy, dz);
131 m_extrusion.setElevation(elevation);
132 }
133
134 Extrusion& getExtrusion() {
135 return m_extrusion;
136 }
137
138 protected:
139 bool m_log_features;
140 Extrusion m_extrusion;
141 ProgressInfo& m_logger;
142 };
143}
144
CADEntityStreamer::m_logger
ProgressInfo & m_logger
Progress info used for logging and status reporting.
Definition CADEntityStreamer.h:141
CADEntityStreamer::m_extrusion
Extrusion m_extrusion
The current extrusion direction and elevation.
Definition CADEntityStreamer.h:140
CADEntityStreamer::m_log_features
bool m_log_features
Whether to log each entity as it is streamed.
Definition CADEntityStreamer.h:139
DXFAttributes
DXF Style attributes that can be applied to CAD Entity objects.
Definition DXFAttributes.h:42
DXFValueManager
DXF streams store data in a large numbered index structure.
Definition DXFValueManager.h:46
Extrusion
logic for storing a extrusion data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:1073
ProgressInfo
Used with InfoPipe to signal that the system will be using progress.
Definition ProgressInfo.hpp:303
StringView
The core String View class for the NDEVR API.
Definition StringView.h:58
String
The core String class for the NDEVR API.
Definition String.h:95
Triangle
A three-vertex polygon representing a triangle in N-dimensional space.
Definition Triangle.hpp:142
Vector
A fixed-size array with N dimensions used as the basis for geometric and mathematical types.
Definition Vector.hpp:62
NDEVR
The primary namespace for the NDEVR SDK.
Definition ArialTileFetcherModule.h:35
uint04
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...
Definition BaseValues.hpp:97
fltp08
double fltp08
Defines an alias representing an 8 byte floating-point number.
Definition BaseValues.hpp:150
AngularDimensionData
logic for storing an angular dimension in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:658
ArcData
logic for storing a arc data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:297
Attrib
Logic for storing attribute data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:471
BlockData
A block structure (Similar to a Model) used to share data with CAD.
Definition CADEntities.h:196
BlockInsert
Information for how to place a CAD block within a scene (Similar to Model).
Definition CADEntities.h:529
CADDictionaryObject
A container for information pointing to a CAD dictionary in CAD memory.
Definition CADEntities.h:615
CADImageData
logic for storing a image data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:985
CADMeshData
Stores mesh data in a way optimized for CAD.
Definition CADEntities.h:379
CircleData
logic for storing a circle data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:488
DXFGroup
A type of entity in CAD representing several entities grouped together.
Definition CADEntities.h:1049
DXFMaterial
A DXF friendly material class which contains UV properties similar to a Material object.
Definition CADEntities.h:1033
DiametricDimension
logic for storing an diametric dimension in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:644
DimAlignedData
A CAD measurement similar to AngleMeasurementModel.
Definition CADEntities.h:590
DimOrdinateData
logic for storing an ordinate dimension in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:681
EllipseData
Stores Ellipse information for interfacing with CAD.
Definition CADEntities.h:497
HandleData
A handle used to reference an object in CAD.
Definition CADEntities.h:148
HatchData
logic for storing a hatch-data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:736
HatchEdgeData
Stores information about the edge of a CAD hatch pattern.
Definition CADEntities.h:776
HatchLoopData
Provides loops of data for the CAD hatch pattern.
Definition CADEntities.h:763
ImageDefData
Stores the definition of an Image for easy interface with CAD.
Definition CADEntities.h:1061
LayerData
Layer information shared with CAD.
Definition CADEntities.h:175
LeaderData
logic for storing a leader in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:697
LineData
A CAD-friendly way to store line segment information.
Definition CADEntities.h:510
LineTypeData
information for a type of line in CAD
Definition CADEntities.h:218
LinearDimension
A CAD measurement similar to DistanceMeasurementModel.
Definition CADEntities.h:601
PointData
Point data stored in a friendly way for interfacing with CAD.
Definition CADEntities.h:540
PolylineData
logic for storing a polyline data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:317
RadialDimension
logic for storing a radial dimension in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:631
SplineData
logic for storing a spline data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:362
StyleData
logic for storing a style data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:245
TextData
logic for storing a text data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:451
TraceData
logic for storing a trace data in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:349
ViewportData
logic for storing a viewport in a CAD-friendly way for exporting and importing.
Definition CADEntities.h:902