sprk_exchange.h
165 TranslationNotifier Translate(Units in_units, TranslationOptionsKit const & in_translation_options);
173 ReloadNotifier Reload(TessellationOptionsKit const & in_tessellation_options = TessellationOptionsKit(), TranslationOptionsKit const & in_translation_options = TranslationOptionsKit());
400 /* Gets a list of sheets for this CADModel (if any). Only formats which support the concept of sheets can return a non-empty array.
415 ReloadNotifier Reload(TessellationOptionsKit const & in_options = TessellationOptionsKit(), TranslationOptionsKit const & in_translation_options = TranslationOptionsKit());
553 static Component CreateComponent(HPS::Component const & in_owner, HPS::Component::ComponentType in_type, A3DEntity * in_entity = nullptr);
560 static CADModel CreateCADModel(Model const & in_model = HPS::Factory::CreateModel(), A3DAsmModelFile * in_entity = nullptr, bool in_owns_entity = false);
573 static Capture CreateCapture(HPS::Component const & in_owner, A3DEntity * in_entity = nullptr, bool in_is_default = false);
1120 Configuration(char const * in_name, size_t in_count, Configuration const in_subconfigurations[]);
1256 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);
1279 static ImportNotifier Import(A3DAsmModelFile const * in_model_file, ModelFileImportOptionsKit const & in_options);
1288 static ImportNotifier Import(size_t in_byte_count, byte const in_prc_data[], ModelFileImportOptionsKit const & in_options);
1296 static ImportNotifier Import(ByteArray const & in_prc_data, ModelFileImportOptionsKit const & in_options);
1305 static TranslationNotifier Translate(char const * in_file_name, ImportOptionsKit const & in_options, TranslationOptionsKit const & in_translation_options);
1312 static ExportNotifier Export3MF(CADModel const & in_cad_model, char const * in_file_name, Export3MFOptionsKit const & in_options);
1319 static ExportNotifier Export3MF(KeyPathArray const & in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1327 static ExportNotifier Export3MF(size_t in_count, KeyPath const in_source[], char const * in_file_name, Export3MFOptionsKit const & in_options);
1334 static ExportNotifier Export3MF(KeyPath in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1340 static void ExportACIS(CADModel const & in_cad_model, char const * in_file_name, ExportACISOptionsKit const & in_options);
1346 static void ExportJT(CADModel const & in_cad_model, char const * in_file_name, ExportJTOptionsKit const & in_options);
1353 static ExportNotifier ExportPRC(CADModel const & in_cad_model, char const * in_file_name, ExportPRCOptionsKit const & in_options);
1360 static ExportNotifier ExportPRC(KeyPathArray const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1368 static ExportNotifier ExportPRC(size_t in_count, KeyPath const in_source [], char const * in_file_name, bool in_compress_tessellation = false);
1376 static ExportNotifier ExportPRC(KeyPath const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1398 static void ExportSTL(CADModel const & in_cad_model, char const * in_file_name, ExportSTLOptionsKit const & in_options);
1404 static void ExportU3D(CADModel const & in_cad_model, char const * in_file_name, ExportU3DOptionsKit const & in_options);
1415 static void ExportXML(CADModel const & in_cad_model, char const * in_file_name, ExportXMLOptionsKit const & in_options);
1423 static void ExportIGES(CADModel const & in_cad_model, char const * in_file_name, ExportIGESOptionsKit const & in_options);
1429 static void ExportParasolid(CADModel const & in_cad_model, char const * in_file_name, ExportParasolidOptionsKit const & in_options);
1435 static void ExportSTEP(CADModel const & in_cad_model, char const * in_file_name, ExportSTEPOptionsKit const & in_options);
1522 NURBSConversionOptionsKit & SetUVCurvesComputation(bool in_state, bool in_allow_cross_seam_curves);
1561 NURBSConversionOptionsKit & SetAllowedSurfaces(size_t in_count, SurfaceType const in_allowed_surfaces []);
1576 NURBSConversionOptionsKit & SetAllowedCurves(size_t in_count, CurveType const in_allowed_curves []);
1846 ImportOptionsKit & SetPMISubstitutionFont(char const * in_font_name, bool in_always_substitute = false);
1895 ImportOptionsKit & SetPMIDefaultColor(RGBColor const & in_color, bool in_override_color = false);
1917 ImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
1930 ImportOptionsKit & SetTessellationAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true, bool in_accurate_surface_curvatures = false, double in_accurate_grid_maximum_stitch_length = 0.0);
1965 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], bool const in_recurse_flags[]);
1972 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, BoolArray const & in_recurse_flags);
1982 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], UTF8 const in_logical_names[], bool const in_recurse_flags[]);
1992 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, UTF8Array const & in_logical_names, BoolArray const & in_recurse_flags);
2064 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(size_t in_count, UTF8 const in_reference_sets[], bool in_apply_to_all_levels);
2072 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(UTF8Array const & in_reference_sets, bool in_apply_to_all_levels);
2320 ImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
2353 ImportOptionsKit & SetIncrementalComponentPaths(size_t in_count, HPS::ComponentPath const in_paths[]);
2366 ImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
2774 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
2782 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
2824 bool ShowSearchDirectories(UTF8Array & out_directories, UTF8Array & out_logical_names, BoolArray & out_recurse_flags) const;
2862 bool ShowUnigraphicsPreferredReferenceSets(UTF8Array & out_reference_sets, bool & out_apply_to_all_levels) const;
3043 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3427 /* Dictates whether Visualize will flip pmi when rotating so that text / symbols remain readable.
3428 * \note If exchange reports that a markup does not contain leader lines, but the tessellation does contain lines that markup will not be
3429 * flipped. This is a precaution for models where the leader line geometry was included as part of the markup tessellation and
3449 ModelFileImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
3462 ModelFileImportOptionsKit & SetTessellationAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true, bool in_accurate_surface_curvatures = false, double accurate_grid_maximum_stitch_length = 0.0);
3464 /* Dictates whether Exchange tesselation data will be released from their parent representation items during import.
3465 * \warning Setting this option to true will cause future exports to output without tessellation data.
3510 ModelFileImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
3530 ModelFileImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
3603 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
3611 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
3663 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3745 Export3MFOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths[]);
3760 Export3MFOptionsKit & SetCurrentTessellationRetention(bool in_state, TessellationOptionsKit const & in_tessellation_kit = TessellationOptionsKit());
3770 bool ShowCurrentTessellationRetention(bool & out_state, Exchange::TessellationOptionsKit & out_tessellation_kit) const;
4158 ExportPRCOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths []);
4295 ExportSTLOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
4372 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
5261 TessellationOptionsKit & SetLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
5272 TessellationOptionsKit & SetAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true, bool in_accurate_surface_curvatures = false, double in_accurate_grid_maximum_stitch_length = 0.0);
5313 bool ShowLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
5321 bool ShowAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
5355 CommonMeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
5406 MeasurementInsertedEvent(HPS::Key const & in_measurement_key, HPS::View const & in_view) : Event()
5452 MeasurementDeletedEvent(HPS::UTF8 const & in_measurement_name, HPS::View const & in_view) : Event()
5514 void PositionLinearMeasurementGeometry(WindowPoint const & window_cursor_location, KeyPath const & event_path, LineKey & leader_line_one, LineKey & leader_line_two,
5515 LineKey & measurement_line, LineKey & line_to_cursor, Point & original_point_one, Point & original_point_two, TextKey & text, UTF8 const & text_string,
5516 Point & distance_point_one, Point & distance_point_two, SegmentKey & current_measurement_segment, Plane const & measurement_plane = Plane(), Vector const & explicit_direction = Vector());
5518 void SetMaterialsOnMeasurementSegment(HPS::SegmentKey const & set_materials_here, HPS::MaterialMappingKit const & materials_to_apply);
5586 MeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
5650 void SetMouseOverHighlighting(bool in_highlighting, HighlightOptionsKit const & in_highlight_options_kit);
5668 enum class EdgeType //used to determine the type of edge measured when using the EdgeAndRadius measurement type
5675 class Surface //helper class containing surfaces properties. Used for the FeatureToFeature measurement type
5690 LineKey normal_points; //the line representing the center line of surfaces of type Cylinder or Cone
5722 bool use_explicit_direction; //if true, we are moving the measurement along a specific vector, called explicit_direction
5746 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'
5758 bool highlight_on_mouse_over; //whether measurable geometry should be highlighted on mouse over
5759 HighlightOptionsKit mouse_over_highlight_options; //the options used for mouse over highlighting
5760 HighlightOptionsKit edit_measurement_highlight_options; //the options used for highlighting measurements while editing them
5761 UpdateNotifier highlight_update_notifier; //notifier used to know if the last highlight update has completed
5763 bool disable_highlighting; //in some situation we temporarily disable highlighting to improve performance
5764 bool Highlight(MeasurementType in_measurement_type, WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path);
5767 bool InputDown(WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path, size_t number_of_clicks);
5774 bool InsertEdgeRadiusMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_edge_key);
5775 bool InsertFeatureToFeatureMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window);
5776 void InsertFeatureToFeatureGeometry(Point const & point_one, Point const & point_two, float distance);
5777 bool InsertAngleMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window, SelectionResults const & in_selection_results);
5806 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);
5807 Point ClosestPointOnTriangleToPoint(Point const & p, Point const & a, Point const & b, Point const & c);
5808 float ClosestPointSegmentSegment(Point const & p1, Point const & q1, Point const & p2, Point const & q2, Point & c1, Point & c2);
5810 Point GetPlaneIntersection(Plane const & in_plane, KeyPath const & in_key_path, WindowPoint const & in_window_point);
Definition: hps.h:6261
Definition: sprk_exchange.h:4056
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3939
Definition: sprk_exchange.h:44
Definition: sprk_exchange.h:5442
Definition: sprk_exchange.h:1024
Definition: sprk.h:273
Definition: sprk_exchange.h:1190
Definition: sprk_exchange.h:5339
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:5865
Definition: sprk.h:67
Definition: sprk.h:106
virtual HPS::UTF8 GetName() const override
Definition: sprk_exchange.h:5358
Definition: sprk_exchange.h:653
Definition: sprk_exchange.h:3364
Definition: sprk_exchange.h:921
Definition: sprk_exchange.h:754
HPS::Type ObjectType() const
Definition: sprk_exchange.h:736
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4514
Definition: hps.h:1740
HPS::Type ObjectType() const
Definition: sprk_exchange.h:783
Definition: sprk_exchange.h:4497
Definition: sprk.h:242
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6727
std::vector< byte, Allocator< byte > > ByteArray
Array of type HPS::byte.
Definition: hps.h:6703
Definition: hps.h:48690
Definition: hps.h:7768
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4073
std::vector< bool, Allocator< bool > > BoolArray
Array of type bool.
Definition: hps.h:6697
Definition: hps.h:16417
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4634
Definition: sprk_exchange.h:501
Definition: sprk_exchange.h:592
Definition: sprk_exchange.h:334
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4812
MeasurementInsertedEvent(Event const &in_event)
Definition: sprk_exchange.h:5416
Definition: sprk_exchange.h:1444
Definition: sprk_exchange.h:274
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4230
Definition: sprk_exchange.h:5396
Definition: sprk_exchange.h:3922
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3120
Definition: hps.h:48588
Definition: hps.h:41976
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1144
Definition: sprk_exchange.h:3820
Definition: sprk_exchange.h:3097
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4973
Definition: hps.h:4539
MeasurementInsertedEvent()
Definition: sprk_exchange.h:5400
Definition: sprk_exchange.h:897
Definition: sprk_exchange.h:4213
Definition: sprk_exchange.h:113
Definition: sprk_exchange.h:996
Definition: hps.h:4478
Definition: hps.h:7139
Definition: hps.h:48059
Definition: sprk_exchange.h:455
Definition: hps.h:43984
Definition: hps.h:48475
Definition: sprk_dwg.h:43
Definition: sprk_exchange.h:4396
Definition: sprk_exchange.h:961
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3837
Definition: hps.h:15804
Event * Clone() const
Definition: sprk_exchange.h:5478
Definition: sprk_exchange.h:1089
Definition: sprk.h:1781
Definition: hps.h:48797
Definition: hps.h:45183
Definition: hps.h:47566
Definition: sprk_exchange.h:546
Definition: hps.h:6345
Definition: hps.h:14052
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5205
std::vector< UTF8, Allocator< UTF8 > > UTF8Array
Array of type HPS::UTF8.
Definition: hps.h:6695
Definition: sprk_exchange.h:5573
Definition: sprk.h:487
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1692
Definition: sprk_parasolid.h:39
Definition: sprk.h:2161
Definition: sprk_exchange.h:3673
Definition: sprk_exchange.h:4617
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1467
MeasurementDeletedEvent(Event const &in_event)
Definition: sprk_exchange.h:5462
Definition: sprk.h:2660
Definition: sprk_exchange.h:1669
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3387
HPS::Type ObjectType() const
Definition: sprk_exchange.h:682
Definition: sprk.h:2760
virtual HPS::UTF8 GetName() const override
Definition: sprk_exchange.h:5589
Definition: hps.h:7686
Definition: sprk_exchange.h:1043
Event * Clone() const
Definition: sprk_exchange.h:5432
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4413
Definition: hps.h:9399
HPS::Type ObjectType() const
Definition: sprk_exchange.h:236
Definition: sprk_exchange.h:707
Definition: hps.h:24604
Definition: sprk.h:2847
Definition: hps.h:31037
Definition: sprk_exchange.h:1106
Definition: hps.h:513
Definition: sprk.h:1110
Definition: sprk_exchange.h:3052
MeasurementDeletedEvent()
Definition: sprk_exchange.h:5446
static Model CreateModel(char const *in_name="")
Definition: sprk_exchange.h:4795
Definition: sprk_exchange.h:203
Definition: hps.h:41472
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3690
Definition: sprk_exchange.h:5188
HPS::Type ObjectType() const
Definition: sprk_exchange.h:621
Definition: hps.h:42607
Definition: sprk_exchange.h:4956