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[]);
1282 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);
1305 static ImportNotifier Import(A3DAsmModelFile const * in_model_file, ModelFileImportOptionsKit const & in_options);
1314 static ImportNotifier Import(size_t in_byte_count, byte const in_prc_data[], ModelFileImportOptionsKit const & in_options);
1322 static ImportNotifier Import(ByteArray const & in_prc_data, ModelFileImportOptionsKit const & in_options);
1331 static TranslationNotifier Translate(char const * in_file_name, ImportOptionsKit const & in_options, TranslationOptionsKit const & in_translation_options);
1338 static ExportNotifier Export3MF(CADModel const & in_cad_model, char const * in_file_name, Export3MFOptionsKit const & in_options);
1345 static ExportNotifier Export3MF(KeyPathArray const & in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1353 static ExportNotifier Export3MF(size_t in_count, KeyPath const in_source[], char const * in_file_name, Export3MFOptionsKit const & in_options);
1360 static ExportNotifier Export3MF(KeyPath in_source, char const * in_file_name, Export3MFOptionsKit const & in_options);
1366 static void ExportFBX(CADModel const & in_cad_model, char const * in_file_name, ExportFBXOptionsKit const & in_options);
1372 static void ExportACIS(CADModel const & in_cad_model, char const * in_file_name, ExportACISOptionsKit const & in_options);
1378 static void ExportJT(CADModel const & in_cad_model, char const * in_file_name, ExportJTOptionsKit const & in_options);
1385 static ExportNotifier ExportPRC(CADModel const & in_cad_model, char const * in_file_name, ExportPRCOptionsKit const & in_options);
1392 static ExportNotifier ExportPRC(KeyPathArray const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1400 static ExportNotifier ExportPRC(size_t in_count, KeyPath const in_source [], char const * in_file_name, bool in_compress_tessellation = false);
1408 static ExportNotifier ExportPRC(KeyPath const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1430 static void ExportSTL(CADModel const & in_cad_model, char const * in_file_name, ExportSTLOptionsKit const & in_options);
1436 static void ExportOBJ(CADModel const & in_cad_model, char const * in_file_name, ExportOBJOptionsKit const & in_options);
1442 static void ExportU3D(CADModel const & in_cad_model, char const * in_file_name, ExportU3DOptionsKit const & in_options);
1453 static void ExportXML(CADModel const & in_cad_model, char const * in_file_name, ExportXMLOptionsKit const & in_options);
1459 static void ExportGLTF(CADModel const & in_cad_model, char const * in_file_name, ExportGLTFOptionsKit const & in_options);
1468 static void ExportIGES(CADModel const & in_cad_model, char const * in_file_name, ExportIGESOptionsKit const & in_options);
1474 static void ExportParasolid(CADModel const & in_cad_model, char const * in_file_name, ExportParasolidOptionsKit const & in_options);
1480 static void ExportSTEP(CADModel const & in_cad_model, char const * in_file_name, ExportSTEPOptionsKit const & in_options);
1567 NURBSConversionOptionsKit & SetUVCurvesComputation(bool in_state, bool in_allow_cross_seam_curves);
1606 NURBSConversionOptionsKit & SetAllowedSurfaces(size_t in_count, SurfaceType const in_allowed_surfaces []);
1621 NURBSConversionOptionsKit & SetAllowedCurves(size_t in_count, CurveType const in_allowed_curves []);
1900 ImportOptionsKit & SetPMISubstitutionFont(char const * in_font_name, bool in_always_substitute = false);
1949 ImportOptionsKit & SetPMIDefaultColor(RGBColor const & in_color, bool in_override_color = false);
1971 ImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
1984 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);
2019 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], bool const in_recurse_flags[]);
2026 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, BoolArray const & in_recurse_flags);
2036 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], UTF8 const in_logical_names[], bool const in_recurse_flags[]);
2046 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, UTF8Array const & in_logical_names, BoolArray const & in_recurse_flags);
2125 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(size_t in_count, UTF8 const in_reference_sets[], bool in_apply_to_all_levels);
2133 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(UTF8Array const & in_reference_sets, bool in_apply_to_all_levels);
2385 ImportOptionsKit & SetRevitPhysicalProperties(Revit::PhysicalProperties in_physical_properties);
2403 ImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
2436 ImportOptionsKit & SetIncrementalComponentPaths(size_t in_count, HPS::ComponentPath const in_paths[]);
2449 ImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
2457 /* When this option is enabled, translations that are deemed to be especially large compared to the model size are removed from the
2458 * scene graph and instead imported as user data, at the index specified, on the segment where the translation would have been.
2459 * Removing very large translation is useful to avoid visual artifacts due to loss in precision.
2461 * If you are adding a model to an existing scene through the SetLocation feature, and the original model was loaded using the
2462 * SetLargeTranslationExtraction setting, the same data_index value should be used for the model being added to the existing scene,
2463 * so that any translations previously extracted from the model can be taken into account during import.
2465 * \param in_data_index The index at which the user data representing the extracted translation will be stored
2898 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
2906 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
2948 bool ShowSearchDirectories(UTF8Array & out_directories, UTF8Array & out_logical_names, BoolArray & out_recurse_flags) const;
2991 bool ShowUnigraphicsPreferredReferenceSets(UTF8Array & out_reference_sets, bool & out_apply_to_all_levels) const;
3187 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3196 * \param out_data_index The index at which the user data representing the extracted translation will be stored
3197 * \return <span class='code'>true</span> if a large translation extraction setting was specified, <span class='code'>false</span> otherwise. */
3577 /* Dictates whether Visualize will flip pmi when rotating so that text / symbols remain readable.
3578 * \note If exchange reports that a markup does not contain leader lines, but the tessellation does contain lines that markup will not be
3579 * flipped. This is a precaution for models where the leader line geometry was included as part of the markup tessellation and
3599 ModelFileImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
3612 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);
3614 /* Dictates whether Exchange tesselation data will be released from their parent representation items during import.
3615 * \warning Setting this option to true will cause future exports to output without tessellation data.
3660 ModelFileImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
3680 ModelFileImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
3763 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
3771 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
3823 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3910 Export3MFOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths[]);
3925 Export3MFOptionsKit & SetCurrentTessellationRetention(bool in_state, TessellationOptionsKit const & in_tessellation_kit = TessellationOptionsKit());
3935 bool ShowCurrentTessellationRetention(bool & out_state, Exchange::TessellationOptionsKit & out_tessellation_kit) const;
4428 ExportPRCOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths []);
4565 ExportSTLOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
4642 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
5718 TessellationOptionsKit & SetLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
5729 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);
5770 bool ShowLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
5778 bool ShowAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals, bool & out_accurate_surface_curvatures, double & out_accurate_grid_maximum_stitch_length) const;
5812 CommonMeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
5863 MeasurementInsertedEvent(HPS::Key const & in_measurement_key, HPS::View const & in_view) : Event()
5909 MeasurementDeletedEvent(HPS::UTF8 const & in_measurement_name, HPS::View const & in_view) : Event()
5971 void PositionLinearMeasurementGeometry(WindowPoint const & window_cursor_location, KeyPath const & event_path, LineKey & leader_line_one, LineKey & leader_line_two,
5972 LineKey & measurement_line, LineKey & line_to_cursor, Point & original_point_one, Point & original_point_two, TextKey & text, UTF8 const & text_string,
5973 Point & distance_point_one, Point & distance_point_two, SegmentKey & current_measurement_segment, Plane const & measurement_plane = Plane(), Vector const & explicit_direction = Vector());
5975 void SetMaterialsOnMeasurementSegment(HPS::SegmentKey const & set_materials_here, HPS::MaterialMappingKit const & materials_to_apply);
6043 MeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
6107 void SetMouseOverHighlighting(bool in_highlighting, HighlightOptionsKit const & in_highlight_options_kit);
6125 enum class EdgeType //used to determine the type of edge measured when using the EdgeAndRadius measurement type
6132 class Surface //helper class containing surfaces properties. Used for the FeatureToFeature measurement type
6147 LineKey normal_points; //the line representing the center line of surfaces of type Cylinder or Cone
6179 bool use_explicit_direction; //if true, we are moving the measurement along a specific vector, called explicit_direction
6203 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'
6215 bool highlight_on_mouse_over; //whether measurable geometry should be highlighted on mouse over
6216 HighlightOptionsKit mouse_over_highlight_options; //the options used for mouse over highlighting
6217 HighlightOptionsKit edit_measurement_highlight_options; //the options used for highlighting measurements while editing them
6218 UpdateNotifier highlight_update_notifier; //notifier used to know if the last highlight update has completed
6220 bool disable_highlighting; //in some situation we temporarily disable highlighting to improve performance
6221 bool Highlight(MeasurementType in_measurement_type, WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path);
6224 bool InputDown(WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path, size_t number_of_clicks);
6231 bool InsertEdgeRadiusMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_edge_key);
6232 bool InsertFeatureToFeatureMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window);
6233 void InsertFeatureToFeatureGeometry(Point const & point_one, Point const & point_two, float distance);
6234 bool InsertAngleMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window, SelectionResults const & in_selection_results);
6262 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);
6263 Point ClosestPointOnTriangleToPoint(Point const & p, Point const & a, Point const & b, Point const & c);
6264 float ClosestPointSegmentSegment(Point const & p1, Point const & q1, Point const & p2, Point const & q2, Point & c1, Point & c2);
6266 Point GetPlaneIntersection(Plane const & in_plane, KeyPath const & in_key_path, WindowPoint const & in_window_point);
Definition: hps.h:6460
Definition: hps.h:85
Definition: sprk_exchange.h:4326
Definition: sprk_exchange.h:44
Definition: sprk_exchange.h:5899
Definition: sprk_exchange.h:1031
Definition: sprk.h:1102
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5325
Definition: sprk_exchange.h:1214
Definition: sprk_exchange.h:5796
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4683
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4986
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:6064
Definition: sprk.h:68
Definition: sprk.h:936
virtual HPS::UTF8 GetName() const override
Definition: sprk_exchange.h:5815
Definition: sprk_exchange.h:656
Definition: sprk_exchange.h:3514
Definition: sprk_exchange.h:927
Definition: sprk_exchange.h:757
Definition: hps.h:1790
Definition: sprk_exchange.h:4849
Definition: sprk.h:1071
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5662
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6926
std::vector< byte, Allocator< byte > > ByteArray
Array of type HPS::byte.
Definition: hps.h:6902
Definition: hps.h:49215
Definition: hps.h:7971
std::vector< bool, Allocator< bool > > BoolArray
Array of type bool.
Definition: hps.h:6896
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3855
Definition: hps.h:16737
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:1512
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4866
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4765
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4002
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:5873
Definition: sprk_exchange.h:5539
Definition: sprk_exchange.h:1489
Definition: sprk_exchange.h:274
Definition: sprk_exchange.h:5853
HPS::Type ObjectType() const
Definition: sprk_exchange.h:624
Definition: sprk_exchange.h:4192
Definition: sprk_exchange.h:1113
Definition: sprk_exchange.h:4666
Definition: hps.h:49113
Definition: hps.h:42477
Definition: sprk_exchange.h:4090
Definition: sprk_exchange.h:3247
Event * Clone() const
Definition: sprk_exchange.h:5935
Definition: hps.h:4649
MeasurementInsertedEvent()
Definition: sprk_exchange.h:5857
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3537
Definition: sprk_exchange.h:903
Definition: sprk_exchange.h:4483
Definition: sprk_exchange.h:113
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5556
Definition: sprk_exchange.h:1003
Definition: sprk_exchange.h:3985
Definition: hps.h:4588
Definition: hps.h:7342
Definition: hps.h:48584
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4107
Definition: sprk_exchange.h:455
Definition: hps.h:44490
Definition: hps.h:49000
Definition: sprk_dwg.h:43
Definition: sprk_exchange.h:4748
Definition: sprk_exchange.h:967
Definition: hps.h:16110
Definition: sprk_exchange.h:1096
Definition: sprk.h:2654
Definition: hps.h:49322
Definition: hps.h:45698
Definition: hps.h:48091
Definition: sprk_exchange.h:549
Definition: hps.h:6544
Definition: hps.h:14358
std::vector< UTF8, Allocator< UTF8 > > UTF8Array
Array of type HPS::UTF8.
Definition: hps.h:6894
Definition: sprk_exchange.h:6030
Definition: sprk.h:1317
HPS::Type ObjectType() const
Definition: sprk_exchange.h:5164
Definition: sprk_parasolid.h:39
Definition: sprk.h:3026
Definition: sprk_exchange.h:3838
Definition: sprk_exchange.h:4969
MeasurementDeletedEvent(Event const &in_event)
Definition: sprk_exchange.h:5919
Definition: sprk.h:3732
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4500
Definition: sprk_exchange.h:1714
Definition: sprk.h:3832
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4209
virtual HPS::UTF8 GetName() const override
Definition: sprk_exchange.h:6046
Event * Clone() const
Definition: sprk_exchange.h:5889
Definition: hps.h:7889
HPS::Type ObjectType() const
Definition: sprk_exchange.h:685
Definition: sprk_exchange.h:1050
Definition: hps.h:9602
HPS::Type ObjectType() const
Definition: sprk_exchange.h:739
Definition: sprk_exchange.h:710
Definition: hps.h:25017
Definition: sprk.h:3919
Definition: hps.h:31450
Definition: sprk_exchange.h:1130
Definition: hps.h:538
Definition: sprk.h:1945
Definition: sprk_exchange.h:3202
MeasurementDeletedEvent()
Definition: sprk_exchange.h:5903
static Model CreateModel(char const *in_name="")
Definition: sprk_exchange.h:5147
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1737
Definition: sprk_exchange.h:203
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3270
Definition: hps.h:41973
Definition: sprk_exchange.h:5645
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4343
Definition: hps.h:43108
Definition: sprk_exchange.h:5308