sprk_exchange.h
162 TranslationNotifier Translate(Units in_units, TranslationOptionsKit const & in_translation_options);
170 ReloadNotifier Reload(TessellationOptionsKit const & in_tessellation_options = TessellationOptionsKit(), TranslationOptionsKit const & in_translation_options = TranslationOptionsKit());
362 /* Gets a list of sheets for this CADModel (if any). Only formats which support the concept of sheets can return a non-empty array.
377 ReloadNotifier Reload(TessellationOptionsKit const & in_options = TessellationOptionsKit(), TranslationOptionsKit const & in_translation_options = TranslationOptionsKit());
505 static Component CreateComponent(HPS::Component const & in_owner, HPS::Component::ComponentType in_type, A3DEntity * in_entity = nullptr);
512 static CADModel CreateCADModel(Model const & in_model = HPS::Factory::CreateModel(), A3DAsmModelFile * in_entity = nullptr, bool in_owns_entity = false);
525 static Capture CreateCapture(HPS::Component const & in_owner, A3DEntity * in_entity = nullptr, bool in_is_default = false);
1055 Configuration(char const * in_name, size_t in_count, Configuration const in_subconfigurations[]);
1185 static void GetInformation(const char * in_file_name, Format & out_format, UTF8 & out_model_name, UTF8 & out_version, UTF8 & out_author, UTF8 & out_organization, UTF8 & out_time_stamp);
1208 static ImportNotifier Import(A3DAsmModelFile const * in_model_file, ModelFileImportOptionsKit const & in_options);
1217 static ImportNotifier Import(size_t in_byte_count, byte const in_prc_data[], ModelFileImportOptionsKit const & in_options);
1225 static ImportNotifier Import(ByteArray const & in_prc_data, ModelFileImportOptionsKit const & in_options);
1234 static TranslationNotifier Translate(char const * in_file_name, ImportOptionsKit const & in_options, TranslationOptionsKit const & in_translation_options);
1240 static ExportNotifier Export3MF(CADModel const & in_cad_model, char const * in_file_name, Export3MFOptionsKit const & in_options);
1247 static ExportNotifier Export3MF(KeyPathArray const & in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1255 static ExportNotifier Export3MF(size_t in_count, KeyPath const in_source[], char const * in_file_name, Export3MFOptionsKit const & in_options);
1262 static ExportNotifier Export3MF(KeyPath in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1268 static void ExportACIS(CADModel const & in_cad_model, char const * in_file_name, ExportACISOptionsKit const & in_options);
1274 static void ExportIGES(CADModel const & in_cad_model, char const * in_file_name, ExportIGESOptionsKit const & in_options);
1280 static void ExportJT(CADModel const & in_cad_model, char const * in_file_name, ExportJTOptionsKit const & in_options);
1286 static void ExportParasolid(CADModel const & in_cad_model, char const * in_file_name, ExportParasolidOptionsKit const & in_options);
1293 static ExportNotifier ExportPRC(CADModel const & in_cad_model, char const * in_file_name, ExportPRCOptionsKit const & in_options);
1300 static ExportNotifier ExportPRC(KeyPathArray const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1308 static ExportNotifier ExportPRC(size_t in_count, KeyPath const in_source [], char const * in_file_name, bool in_compress_tessellation = false);
1316 static ExportNotifier ExportPRC(KeyPath const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1338 static void ExportSTEP(CADModel const & in_cad_model, char const * in_file_name, ExportSTEPOptionsKit const & in_options);
1344 static void ExportSTL(CADModel const & in_cad_model, char const * in_file_name, ExportSTLOptionsKit const & in_options);
1350 static void ExportU3D(CADModel const & in_cad_model, char const * in_file_name, ExportU3DOptionsKit const & in_options);
1361 static void ExportXML(CADModel const & in_cad_model, char const * in_file_name, ExportXMLOptionsKit const & in_options);
1446 NURBSConversionOptionsKit & SetUVCurvesComputation(bool in_state, bool in_allow_cross_seam_curves);
1485 NURBSConversionOptionsKit & SetAllowedSurfaces(size_t in_count, SurfaceType const in_allowed_surfaces []);
1500 NURBSConversionOptionsKit & SetAllowedCurves(size_t in_count, CurveType const in_allowed_curves []);
1761 ImportOptionsKit & SetPMISubstitutionFont(char const * in_font_name, bool in_always_substitute = false);
1793 ImportOptionsKit & SetPMIDefaultColor(RGBColor const & in_color, bool in_override_color = false);
1815 ImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
1824 ImportOptionsKit & SetTessellationAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true);
1859 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], bool const in_recurse_flags[]);
1866 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, BoolArray const & in_recurse_flags);
1876 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], UTF8 const in_logical_names[], bool const in_recurse_flags[]);
1886 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, UTF8Array const & in_logical_names, BoolArray const & in_recurse_flags);
1950 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(size_t in_count, UTF8 const in_reference_sets[], bool in_apply_to_all_levels);
1958 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(UTF8Array const & in_reference_sets, bool in_apply_to_all_levels);
2191 ImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
2224 ImportOptionsKit & SetIncrementalComponentPaths(size_t in_count, HPS::ComponentPath const in_paths[]);
2237 ImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
2616 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
2622 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals) const;
2654 bool ShowSearchDirectories(UTF8Array & out_directories, UTF8Array & out_logical_names, BoolArray & out_recurse_flags) const;
2686 bool ShowUnigraphicsPreferredReferenceSets(UTF8Array & out_reference_sets, bool & out_apply_to_all_levels) const;
2857 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3223 /* Dictates whether Visualize will flip pmi when rotating so that text / symbols remain readable.
3224 * \note If exchange reports that a markup does not contain leader lines, but the tessellation does contain lines that markup will not be
3225 * flipped. This is a precaution for models where the leader line geometry was included as part of the markup tessellation and
3245 ModelFileImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
3254 ModelFileImportOptionsKit & SetTessellationAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true);
3256 /* Dictates whether Exchange tesselation data will be released from their parent representation items during import.
3257 * \warning Setting this option to true will cause future exports to output without tessellation data.
3302 ModelFileImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
3314 ModelFileImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
3383 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
3389 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals) const;
3435 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3515 Export3MFOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths[]);
3530 Export3MFOptionsKit & SetCurrentTessellationRetention(bool in_state, TessellationOptionsKit const & in_tessellation_kit = TessellationOptionsKit());
3540 bool ShowCurrentTessellationRetention(bool & out_state, Exchange::TessellationOptionsKit & out_tessellation_kit) const;
4247 ExportPRCOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths []);
4586 ExportSTLOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
4663 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
4976 TessellationOptionsKit & SetLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
4983 TessellationOptionsKit & SetAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true);
5024 bool ShowLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
5064 CommonMeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
5115 MeasurementInsertedEvent(HPS::Key const & in_measurement_key, HPS::View const & in_view) : Event()
5161 MeasurementDeletedEvent(HPS::UTF8 const & in_measurement_name, HPS::View const & in_view) : Event()
5223 void PositionLinearMeasurementGeometry(WindowPoint const & window_cursor_location, KeyPath const & event_path, LineKey & leader_line_one, LineKey & leader_line_two,
5224 LineKey & measurement_line, LineKey & line_to_cursor, Point & original_point_one, Point & original_point_two, TextKey & text, UTF8 const & text_string,
5225 Point & distance_point_one, Point & distance_point_two, SegmentKey & current_measurement_segment, Plane const & measurement_plane = Plane(), Vector const & explicit_direction = Vector());
5227 void SetMaterialsOnMeasurementSegment(HPS::SegmentKey const & set_materials_here, HPS::MaterialMappingKit const & materials_to_apply);
5295 MeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
5353 * \param in_highlighting Whether measurable geometry should be highlighted when mousing over it. */
5357 * \param in_highlighting Whether measurable geometry should be highlighted when mousing over it.
5359 void SetMouseOverHighlighting(bool in_highlighting, HighlightOptionsKit const & in_highlight_options_kit);
5362 * \return <span class='code'>true</span> if measurable geometry is highlighted on mouse over, <span class='code'>false</span> otherwise. */
5370 * \return <span class='code'>true</span> if a measurement is being inserted or manipulated, <span class='code'>false</span> otherwise. */
5374 enum class EdgeType //used to determine the type of edge measured when using the EdgeAndRadius measurement type
5381 class Surface //helper class containing surfaces properties. Used for the FeatureToFeature measurement type
5396 LineKey normal_points; //the line representing the center line of surfaces of type Cylinder or Cone
5428 bool use_explicit_direction; //if true, we are moving the measurement along a specific vector, called explicit_direction
5452 bool inverted_measurement; //the smallest of the two possible angles is always chosen. If the user wants the other angle, the measurement is marked as 'inverted'
5464 bool highlight_on_mouse_over; //whether measurable geometry should be highlighted on mouse over
5465 HighlightOptionsKit mouse_over_highlight_options; //the options used for mouse over highlighting
5466 HighlightOptionsKit edit_measurement_highlight_options; //the options used for highlighting measurements while editing them
5467 UpdateNotifier highlight_update_notifier; //notifier used to know if the last highlight update has completed
5469 bool disable_highlighting; //in some situation we temporarily disable highlighting to improve performance
5470 bool Highlight(MeasurementType in_measurement_type, WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path);
5473 bool InputDown(WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path, size_t number_of_clicks);
5480 bool InsertEdgeRadiusMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_edge_key);
5481 bool InsertFeatureToFeatureMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window);
5482 void InsertFeatureToFeatureGeometry(Point const & point_one, Point const & point_two, float distance);
5483 bool InsertAngleMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window, SelectionResults const & in_selection_results);
5512 float LineSegmentDistance(Point & p0, Point & p1, Point & q0, Point & q1, LineKey & normal_one, LineKey & normal_two, Point & out_point_on_edge, Point & out_point_on_center_line, bool clamp = true);
5513 Point ClosestPointOnTriangleToPoint(Point const & p, Point const & a, Point const & b, Point const & c);
5514 float ClosestPointSegmentSegment(Point const & p1, Point const & q1, Point const & p2, Point const & q2, Point & c1, Point & c2);
5516 Point GetPlaneIntersection(Plane const & in_plane, KeyPath const & in_key_path, WindowPoint const & in_window_point);
Definition: hps.h:6109
Definition: sprk_exchange.h:4146
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3884
Definition: sprk_exchange.h:44
Definition: sprk_exchange.h:5151
Definition: sprk_exchange.h:959
Definition: sprk.h:264
Definition: sprk_exchange.h:1124
Definition: sprk_exchange.h:5048
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:5727
Definition: sprk.h:66
Definition: sprk.h:100
Definition: sprk_exchange.h:598
Definition: sprk_exchange.h:3161
Definition: sprk_exchange.h:858
Definition: sprk_exchange.h:697
virtual HPS::UTF8 GetName() const OVERRIDE
Definition: sprk_exchange.h:5067
HPS::Type ObjectType() const
Definition: sprk_exchange.h:679
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4803
Definition: hps.h:1709
HPS::Type ObjectType() const
Definition: sprk_exchange.h:725
Definition: sprk_exchange.h:4787
Definition: sprk.h:234
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6573
std::vector< byte, Allocator< byte > > ByteArray
Array of type HPS::byte.
Definition: hps.h:6549
Definition: hps.h:47100
Definition: hps.h:7607
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4162
std::vector< bool, Allocator< bool > > BoolArray
Array of type bool.
Definition: hps.h:6543
Definition: hps.h:15839
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3707
Definition: sprk_exchange.h:454
Definition: sprk_exchange.h:538
Definition: sprk_exchange.h:297
virtual HPS::UTF8 GetName() const OVERRIDE
Definition: sprk_exchange.h:5298
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4017
MeasurementInsertedEvent(Event const &in_event)
Definition: sprk_exchange.h:5125
Definition: sprk_exchange.h:1369
Definition: sprk_exchange.h:238
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4521
Definition: sprk_exchange.h:5105
Definition: sprk_exchange.h:3868
HPS::Type ObjectType() const
Definition: sprk_exchange.h:2933
Definition: hps.h:46999
Definition: hps.h:40708
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1078
Definition: sprk_exchange.h:3590
Definition: sprk_exchange.h:2911
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4318
Definition: hps.h:4419
MeasurementInsertedEvent()
Definition: sprk_exchange.h:5109
Definition: sprk_exchange.h:834
Definition: sprk_exchange.h:4505
Definition: sprk_exchange.h:111
Definition: sprk_exchange.h:931
Definition: hps.h:4358
Definition: hps.h:6980
Definition: hps.h:46491
Definition: sprk_exchange.h:409
Definition: hps.h:42665
Definition: hps.h:46887
Definition: sprk_dwg.h:43
Definition: sprk_exchange.h:4687
Definition: sprk_exchange.h:896
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3606
Definition: hps.h:15232
Event * Clone() const
Definition: sprk_exchange.h:5187
Definition: sprk_exchange.h:1024
Definition: sprk.h:1724
Definition: hps.h:47206
Definition: hps.h:43788
Definition: hps.h:46010
Definition: sprk_exchange.h:498
Definition: hps.h:6193
Definition: hps.h:13493
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4920
std::vector< UTF8, Allocator< UTF8 > > UTF8Array
Array of type HPS::UTF8.
Definition: hps.h:6541
Definition: sprk_exchange.h:5282
Definition: sprk.h:473
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1615
Definition: sprk_parasolid.h:39
Definition: sprk.h:2038
Definition: sprk_exchange.h:3444
Definition: sprk_exchange.h:3691
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1391
MeasurementDeletedEvent(Event const &in_event)
Definition: sprk_exchange.h:5171
Definition: sprk.h:2357
Definition: sprk_exchange.h:1593
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3183
HPS::Type ObjectType() const
Definition: sprk_exchange.h:626
Definition: sprk.h:2456
Definition: hps.h:7526
Definition: sprk_exchange.h:978
Event * Clone() const
Definition: sprk_exchange.h:5141
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4703
Definition: hps.h:9150
HPS::Type ObjectType() const
Definition: sprk_exchange.h:205
Definition: sprk_exchange.h:651
Definition: hps.h:23627
Definition: sprk.h:2542
Definition: hps.h:30028
Definition: sprk_exchange.h:1041
Definition: hps.h:518
Definition: sprk.h:1093
Definition: sprk_exchange.h:2866
MeasurementDeletedEvent()
Definition: sprk_exchange.h:5155
static Model CreateModel(char const *in_name="")
Definition: sprk_exchange.h:4001
Definition: sprk_exchange.h:173
Definition: hps.h:40205
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3460
Definition: sprk_exchange.h:4904
HPS::Type ObjectType() const
Definition: sprk_exchange.h:566
Definition: hps.h:41318
Definition: sprk_exchange.h:4302