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());
556 static Component CreateComponent(HPS::Component const & in_owner, HPS::Component::ComponentType in_type, A3DEntity * in_entity = nullptr);
563 static CADModel CreateCADModel(Model const & in_model = HPS::Factory::CreateModel(), A3DAsmModelFile * in_entity = nullptr, bool in_owns_entity = false);
576 static Capture CreateCapture(HPS::Component const & in_owner, A3DEntity * in_entity = nullptr, bool in_is_default = false);
1144 Configuration(char const * in_name, size_t in_count, Configuration const in_subconfigurations[]);
1280 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);
1303 static ImportNotifier Import(A3DAsmModelFile const * in_model_file, ModelFileImportOptionsKit const & in_options);
1312 static ImportNotifier Import(size_t in_byte_count, byte const in_prc_data[], ModelFileImportOptionsKit const & in_options);
1320 static ImportNotifier Import(ByteArray const & in_prc_data, ModelFileImportOptionsKit const & in_options);
1329 static TranslationNotifier Translate(char const * in_file_name, ImportOptionsKit const & in_options, TranslationOptionsKit const & in_translation_options);
1336 static ExportNotifier Export3MF(CADModel const & in_cad_model, char const * in_file_name, Export3MFOptionsKit const & in_options);
1343 static ExportNotifier Export3MF(KeyPathArray const & in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1351 static ExportNotifier Export3MF(size_t in_count, KeyPath const in_source[], char const * in_file_name, Export3MFOptionsKit const & in_options);
1358 static ExportNotifier Export3MF(KeyPath in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1364 static void ExportFBX(CADModel const & in_cad_model, char const * in_file_name, ExportFBXOptionsKit const & in_options);
1370 static void ExportACIS(CADModel const & in_cad_model, char const * in_file_name, ExportACISOptionsKit const & in_options);
1376 static void ExportJT(CADModel const & in_cad_model, char const * in_file_name, ExportJTOptionsKit const & in_options);
1383 static ExportNotifier ExportPRC(CADModel const & in_cad_model, char const * in_file_name, ExportPRCOptionsKit const & in_options);
1390 static ExportNotifier ExportPRC(KeyPathArray const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1398 static ExportNotifier ExportPRC(size_t in_count, KeyPath const in_source [], char const * in_file_name, bool in_compress_tessellation = false);
1406 static ExportNotifier ExportPRC(KeyPath const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1428 static void ExportSTL(CADModel const & in_cad_model, char const * in_file_name, ExportSTLOptionsKit const & in_options);
1434 static void ExportOBJ(CADModel const & in_cad_model, char const * in_file_name, ExportOBJOptionsKit const & in_options);
1440 static void ExportU3D(CADModel const & in_cad_model, char const * in_file_name, ExportU3DOptionsKit const & in_options);
1451 static void ExportXML(CADModel const & in_cad_model, char const * in_file_name, ExportXMLOptionsKit const & in_options);
1457 static void ExportGLTF(CADModel const & in_cad_model, char const * in_file_name, ExportGLTFOptionsKit const & in_options);
1466 static void ExportIGES(CADModel const & in_cad_model, char const * in_file_name, ExportIGESOptionsKit const & in_options);
1472 static void ExportParasolid(CADModel const & in_cad_model, char const * in_file_name, ExportParasolidOptionsKit const & in_options);
1478 static void ExportSTEP(CADModel const & in_cad_model, char const * in_file_name, ExportSTEPOptionsKit const & in_options);
1565 NURBSConversionOptionsKit & SetUVCurvesComputation(bool in_state, bool in_allow_cross_seam_curves);
1604 NURBSConversionOptionsKit & SetAllowedSurfaces(size_t in_count, SurfaceType const in_allowed_surfaces []);
1619 NURBSConversionOptionsKit & SetAllowedCurves(size_t in_count, CurveType const in_allowed_curves []);
1890 ImportOptionsKit & SetPMISubstitutionFont(char const * in_font_name, bool in_always_substitute = false);
1939 ImportOptionsKit & SetPMIDefaultColor(RGBColor const & in_color, bool in_override_color = false);
1961 ImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
1974 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);
2009 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], bool const in_recurse_flags[]);
2016 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, BoolArray const & in_recurse_flags);
2026 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], UTF8 const in_logical_names[], bool const in_recurse_flags[]);
2036 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, UTF8Array const & in_logical_names, BoolArray const & in_recurse_flags);
2115 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(size_t in_count, UTF8 const in_reference_sets[], bool in_apply_to_all_levels);
2123 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(UTF8Array const & in_reference_sets, bool in_apply_to_all_levels);
2361 ImportOptionsKit & SetRevitPhysicalProperties(Revit::PhysicalProperties in_physical_properties);
2379 ImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
2412 ImportOptionsKit & SetIncrementalComponentPaths(size_t in_count, HPS::ComponentPath const in_paths[]);
2425 ImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
2433 /* When this option is enabled, translations that are deemed to be especially large compared to the model size are removed from the
2434 * scene graph and instead imported as user data, at the index specified, on the segment where the translation would have been.
2435 * Removing very large translation is useful to avoid visual artifacts due to loss in precision.
2437 * If you are adding a model to an existing scene through the SetLocation feature, and the original model was loaded using the
2438 * SetLargeTranslationExtraction setting, the same data_index value should be used for the model being added to the existing scene,
2439 * so that any translations previously extracted from the model can be taken into account during import.
2441 * \param in_data_index The index at which the user data representing the extracted translation will be stored
2857 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
2865 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
2907 bool ShowSearchDirectories(UTF8Array & out_directories, UTF8Array & out_logical_names, BoolArray & out_recurse_flags) const;
2950 bool ShowUnigraphicsPreferredReferenceSets(UTF8Array & out_reference_sets, bool & out_apply_to_all_levels) const;
3136 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3145 * \param out_data_index The index at which the user data representing the extracted translation will be stored
3146 * \return <span class='code'>true</span> if a large translation extraction setting was specified, <span class='code'>false</span> otherwise. */
3526 /* Dictates whether Visualize will flip pmi when rotating so that text / symbols remain readable.
3527 * \note If exchange reports that a markup does not contain leader lines, but the tessellation does contain lines that markup will not be
3528 * flipped. This is a precaution for models where the leader line geometry was included as part of the markup tessellation and
3548 ModelFileImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
3561 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);
3563 /* Dictates whether Exchange tesselation data will be released from their parent representation items during import.
3564 * \warning Setting this option to true will cause future exports to output without tessellation data.
3609 ModelFileImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
3629 ModelFileImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
3712 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
3720 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
3772 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3859 Export3MFOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths[]);
3874 Export3MFOptionsKit & SetCurrentTessellationRetention(bool in_state, TessellationOptionsKit const & in_tessellation_kit = TessellationOptionsKit());
3884 bool ShowCurrentTessellationRetention(bool & out_state, Exchange::TessellationOptionsKit & out_tessellation_kit) const;
4377 ExportPRCOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths []);
4514 ExportSTLOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
4591 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
5667 TessellationOptionsKit & SetLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
5678 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);
5719 bool ShowLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
5727 bool ShowAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
5761 CommonMeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
5812 MeasurementInsertedEvent(HPS::Key const & in_measurement_key, HPS::View const & in_view) : Event()
5858 MeasurementDeletedEvent(HPS::UTF8 const & in_measurement_name, HPS::View const & in_view) : Event()
5920 void PositionLinearMeasurementGeometry(WindowPoint const & window_cursor_location, KeyPath const & event_path, LineKey & leader_line_one, LineKey & leader_line_two,
5921 LineKey & measurement_line, LineKey & line_to_cursor, Point & original_point_one, Point & original_point_two, TextKey & text, UTF8 const & text_string,
5922 Point & distance_point_one, Point & distance_point_two, SegmentKey & current_measurement_segment, Plane const & measurement_plane = Plane(), Vector const & explicit_direction = Vector());
5924 void SetMaterialsOnMeasurementSegment(HPS::SegmentKey const & set_materials_here, HPS::MaterialMappingKit const & materials_to_apply);
5992 MeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
6056 void SetMouseOverHighlighting(bool in_highlighting, HighlightOptionsKit const & in_highlight_options_kit);
6074 enum class EdgeType //used to determine the type of edge measured when using the EdgeAndRadius measurement type
6081 class Surface //helper class containing surfaces properties. Used for the FeatureToFeature measurement type
6096 LineKey normal_points; //the line representing the center line of surfaces of type Cylinder or Cone
6128 bool use_explicit_direction; //if true, we are moving the measurement along a specific vector, called explicit_direction
6152 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'
6164 bool highlight_on_mouse_over; //whether measurable geometry should be highlighted on mouse over
6165 HighlightOptionsKit mouse_over_highlight_options; //the options used for mouse over highlighting
6166 HighlightOptionsKit edit_measurement_highlight_options; //the options used for highlighting measurements while editing them
6167 UpdateNotifier highlight_update_notifier; //notifier used to know if the last highlight update has completed
6169 bool disable_highlighting; //in some situation we temporarily disable highlighting to improve performance
6170 bool Highlight(MeasurementType in_measurement_type, WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path);
6173 bool InputDown(WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path, size_t number_of_clicks);
6180 bool InsertEdgeRadiusMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_edge_key);
6181 bool InsertFeatureToFeatureMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window);
6182 void InsertFeatureToFeatureGeometry(Point const & point_one, Point const & point_two, float distance);
6183 bool InsertAngleMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window, SelectionResults const & in_selection_results);
6211 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);
6212 Point ClosestPointOnTriangleToPoint(Point const & p, Point const & a, Point const & b, Point const & c);
6213 float ClosestPointSegmentSegment(Point const & p1, Point const & q1, Point const & p2, Point const & q2, Point & c1, Point & c2);
6215 Point GetPlaneIntersection(Plane const & in_plane, KeyPath const & in_key_path, WindowPoint const & in_window_point);
Definition: hps.h:6418
Definition: hps.h:85
Definition: sprk_exchange.h:4275
Definition: sprk_exchange.h:44
Definition: sprk_exchange.h:5848
Definition: sprk_exchange.h:1031
Definition: sprk.h:1103
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5274
Definition: sprk_exchange.h:1214
Definition: sprk_exchange.h:5745
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4632
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4935
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:6022
Definition: sprk.h:68
Definition: sprk.h:936
virtual HPS::UTF8 GetName() const override
Definition: sprk_exchange.h:5764
Definition: sprk_exchange.h:656
Definition: sprk_exchange.h:3463
Definition: sprk_exchange.h:927
Definition: sprk_exchange.h:757
Definition: hps.h:1766
Definition: sprk_exchange.h:4798
Definition: sprk.h:1072
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5611
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6884
std::vector< byte, Allocator< byte > > ByteArray
Array of type HPS::byte.
Definition: hps.h:6860
Definition: hps.h:49119
Definition: hps.h:7929
std::vector< bool, Allocator< bool > > BoolArray
Array of type bool.
Definition: hps.h:6854
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3804
Definition: hps.h:16646
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1168
Definition: sprk_exchange.h:504
Definition: sprk_exchange.h:595
Definition: sprk_exchange.h:334
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1510
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4815
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4714
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3951
HPS::Type ObjectType() const
Definition: sprk_exchange.h:236
HPS::Type ObjectType() const
Definition: sprk_exchange.h:786
MeasurementInsertedEvent(Event const &in_event)
Definition: sprk_exchange.h:5822
Definition: sprk_exchange.h:5488
Definition: sprk_exchange.h:1487
Definition: sprk_exchange.h:274
Definition: sprk_exchange.h:5802
HPS::Type ObjectType() const
Definition: sprk_exchange.h:624
Definition: sprk_exchange.h:4141
Definition: sprk_exchange.h:1113
Definition: sprk_exchange.h:4615
Definition: hps.h:49017
Definition: hps.h:42386
Definition: sprk_exchange.h:4039
Definition: sprk_exchange.h:3196
Event * Clone() const
Definition: sprk_exchange.h:5884
Definition: hps.h:4607
MeasurementInsertedEvent()
Definition: sprk_exchange.h:5806
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3486
Definition: sprk_exchange.h:903
Definition: sprk_exchange.h:4432
Definition: sprk_exchange.h:113
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5505
Definition: sprk_exchange.h:1003
Definition: sprk_exchange.h:3934
Definition: hps.h:4546
Definition: hps.h:7300
Definition: hps.h:48488
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4056
Definition: sprk_exchange.h:455
Definition: hps.h:44399
Definition: hps.h:48904
Definition: sprk_dwg.h:43
Definition: sprk_exchange.h:4697
Definition: sprk_exchange.h:967
Definition: hps.h:16019
Definition: sprk_exchange.h:1096
Definition: sprk.h:2622
Definition: hps.h:49226
Definition: hps.h:45606
Definition: hps.h:47995
Definition: sprk_exchange.h:549
Definition: hps.h:6502
Definition: hps.h:14267
std::vector< UTF8, Allocator< UTF8 > > UTF8Array
Array of type HPS::UTF8.
Definition: hps.h:6852
Definition: sprk_exchange.h:5979
Definition: sprk.h:1318
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5113
Definition: sprk_parasolid.h:39
Definition: sprk.h:2994
Definition: sprk_exchange.h:3787
Definition: sprk_exchange.h:4918
MeasurementDeletedEvent(Event const &in_event)
Definition: sprk_exchange.h:5868
Definition: sprk.h:3700
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4449
Definition: sprk_exchange.h:1712
Definition: sprk.h:3800
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4158
virtual HPS::UTF8 GetName() const override
Definition: sprk_exchange.h:5995
Event * Clone() const
Definition: sprk_exchange.h:5838
Definition: hps.h:7847
HPS::Type ObjectType() const
Definition: sprk_exchange.h:685
Definition: sprk_exchange.h:1050
Definition: hps.h:9560
HPS::Type ObjectType() const
Definition: sprk_exchange.h:739
Definition: sprk_exchange.h:710
Definition: hps.h:24926
Definition: sprk.h:3887
Definition: hps.h:31359
Definition: sprk_exchange.h:1130
Definition: hps.h:514
Definition: sprk.h:1946
Definition: sprk_exchange.h:3151
MeasurementDeletedEvent()
Definition: sprk_exchange.h:5852
static Model CreateModel(char const *in_name="")
Definition: sprk_exchange.h:5096
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1735
Definition: sprk_exchange.h:203
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3219
Definition: hps.h:41882
Definition: sprk_exchange.h:5594
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4292
Definition: hps.h:43017
Definition: sprk_exchange.h:5257