sprk_exchange.h
161 TranslationNotifier Translate(Units in_units, TranslationOptionsKit const & in_translation_options);
169 ReloadNotifier Reload(TessellationOptionsKit const & in_tessellation_options = TessellationOptionsKit(), TranslationOptionsKit const & in_translation_options = TranslationOptionsKit());
361 /* Gets a list of sheets for this CADModel (if any). Only formats which support the concept of sheets can return a non-empty array.
376 ReloadNotifier Reload(TessellationOptionsKit const & in_options = TessellationOptionsKit(), TranslationOptionsKit const & in_translation_options = TranslationOptionsKit());
497 static Component CreateComponent(HPS::Component const & in_owner, HPS::Component::ComponentType in_type, A3DEntity * in_entity = nullptr);
504 static CADModel CreateCADModel(Model const & in_model = HPS::Factory::CreateModel(), A3DAsmModelFile * in_entity = nullptr, bool in_owns_entity = false);
517 static Capture CreateCapture(HPS::Component const & in_owner, A3DEntity * in_entity = nullptr, bool in_is_default = false);
1031 Configuration(char const * in_name, size_t in_count, Configuration const in_subconfigurations[]);
1159 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);
1182 static ImportNotifier Import(A3DAsmModelFile const * in_model_file, ModelFileImportOptionsKit const & in_options);
1191 static ImportNotifier Import(size_t in_byte_count, byte const in_prc_data[], ModelFileImportOptionsKit const & in_options);
1199 static ImportNotifier Import(ByteArray const & in_prc_data, ModelFileImportOptionsKit const & in_options);
1208 static TranslationNotifier Translate(char const * in_file_name, ImportOptionsKit const & in_options, TranslationOptionsKit const & in_translation_options);
1214 static void ExportACIS(CADModel const & in_cad_model, char const * in_file_name, ExportACISOptionsKit const & in_options);
1220 static void ExportIGES(CADModel const & in_cad_model, char const * in_file_name, ExportIGESOptionsKit const & in_options);
1226 static void ExportJT(CADModel const & in_cad_model, char const * in_file_name, ExportJTOptionsKit const & in_options);
1232 static void ExportParasolid(CADModel const & in_cad_model, char const * in_file_name, ExportParasolidOptionsKit const & in_options);
1239 static ExportNotifier ExportPRC(CADModel const & in_cad_model, char const * in_file_name, ExportPRCOptionsKit const & in_options);
1246 static ExportNotifier ExportPRC(KeyPathArray const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1254 static ExportNotifier ExportPRC(size_t in_count, KeyPath const in_source [], char const * in_file_name, bool in_compress_tessellation = false);
1262 static ExportNotifier ExportPRC(KeyPath const & in_source, char const * in_file_name, bool in_compress_tessellation = false);
1284 static void ExportSTEP(CADModel const & in_cad_model, char const * in_file_name, ExportSTEPOptionsKit const & in_options);
1290 static void ExportSTL(CADModel const & in_cad_model, char const * in_file_name, ExportSTLOptionsKit const & in_options);
1296 static void ExportU3D(CADModel const & in_cad_model, char const * in_file_name, ExportU3DOptionsKit const & in_options);
1307 static void ExportXML(CADModel const & in_cad_model, char const * in_file_name, ExportXMLOptionsKit const & in_options);
1392 NURBSConversionOptionsKit & SetUVCurvesComputation(bool in_state, bool in_allow_cross_seam_curves);
1431 NURBSConversionOptionsKit & SetAllowedSurfaces(size_t in_count, SurfaceType const in_allowed_surfaces []);
1446 NURBSConversionOptionsKit & SetAllowedCurves(size_t in_count, CurveType const in_allowed_curves []);
1692 ImportOptionsKit & SetPMISubstitutionFont(char const * in_font_name, bool in_always_substitute = false);
1721 ImportOptionsKit & SetPMIDefaultColor(RGBColor const & in_color, bool in_override_color = false);
1743 ImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
1752 ImportOptionsKit & SetTessellationAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true);
1787 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], bool const in_recurse_flags[]);
1794 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, BoolArray const & in_recurse_flags);
1804 ImportOptionsKit & SetSearchDirectories(size_t in_count, UTF8 const in_directories[], UTF8 const in_logical_names[], bool const in_recurse_flags[]);
1814 ImportOptionsKit & SetSearchDirectories(UTF8Array const & in_directories, UTF8Array const & in_logical_names, BoolArray const & in_recurse_flags);
1878 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(size_t in_count, UTF8 const in_reference_sets[], bool in_apply_to_all_levels);
1886 ImportOptionsKit & SetUnigraphicsPreferredReferenceSets(UTF8Array const & in_reference_sets, bool in_apply_to_all_levels);
2112 ImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
2145 ImportOptionsKit & SetIncrementalComponentPaths(size_t in_count, HPS::ComponentPath const in_paths[]);
2158 ImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
2508 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
2514 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals) const;
2546 bool ShowSearchDirectories(UTF8Array & out_directories, UTF8Array & out_logical_names, BoolArray & out_recurse_flags) const;
2578 bool ShowUnigraphicsPreferredReferenceSets(UTF8Array & out_reference_sets, bool & out_apply_to_all_levels) const;
2744 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3090 /* Dictates whether Visualize will flip pmi when rotating so that text / symbols remain readable.
3109 ModelFileImportOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
3118 ModelFileImportOptionsKit & SetTessellationAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true);
3120 /* Dictates whether Exchange tesselation data will be released from their parent representation items during import.
3121 * \warning Setting this option to true will cause future exports to output without tessellation data.
3166 ModelFileImportOptionsKit & SetLocation(ComponentPath const & in_path, MatrixKit const & in_transform = MatrixKit());
3178 ModelFileImportOptionsKit & SetNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit const & in_nurbs_conversion_options);
3237 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
3243 bool ShowTessellationAccuracy(Tessellation::Accuracy & out_type, bool & out_accurate_normals) const;
3289 bool ShowNURBSConversion(HPS::Exchange::NURBSConversionOptionsKit & out_nurbs_conversion_options) const;
3935 ExportPRCOptionsKit & SetAdditionalKeyPaths(size_t in_count, KeyPath const in_additional_key_paths []);
4274 ExportSTLOptionsKit & SetTessellationLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
4336 bool ShowTessellationLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
4644 TessellationOptionsKit & SetLevel(Tessellation::Chord::Limit in_limit_type, double in_limit, double in_angle_tolerance);
4651 TessellationOptionsKit & SetAccuracy(Tessellation::Accuracy in_type, bool in_accurate_normals = true);
4692 bool ShowLevel(Tessellation::Type & out_type, Tessellation::Level & out_level, Tessellation::Chord::Limit & out_limit_type, double & out_limit, double & out_angle_tolerance) const;
4732 CommonMeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
4783 MeasurementInsertedEvent(HPS::Key const & in_measurement_key, HPS::View const & in_view) : Event()
4829 MeasurementDeletedEvent(HPS::UTF8 const & in_measurement_name, HPS::View const & in_view) : Event()
4891 void PositionLinearMeasurementGeometry(WindowPoint const & window_cursor_location, KeyPath const & event_path, LineKey & leader_line_one, LineKey & leader_line_two,
4892 LineKey & measurement_line, LineKey & line_to_cursor, Point & original_point_one, Point & original_point_two, TextKey & text, UTF8 const & text_string,
4893 Point & distance_point_one, Point & distance_point_two, SegmentKey & current_measurement_segment, Plane const & measurement_plane = Plane(), Vector const & explicit_direction = Vector());
4895 void SetMaterialsOnMeasurementSegment(HPS::SegmentKey const & set_materials_here, HPS::MaterialMappingKit const & materials_to_apply);
4962 MeasurementOperator(Exchange::CADModel const & in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
5004 * \param in_highlighting Whether measurable geometry should be highlighted when mousing over it. */
5008 * \param in_highlighting Whether measurable geometry should be highlighted when mousing over it.
5010 void SetMouseOverHighlighting(bool in_highlighting, HighlightOptionsKit const & in_highlight_options_kit);
5013 * \return <span class='code'>true</span> if measurable geometry is highlighted on mouse over, <span class='code'>false</span> otherwise. */
5021 * \return <span class='code'>true</span> if a measurement is being inserted or manipulated, <span class='code'>false</span> otherwise. */
5025 enum class EdgeType //used to determine the type of edge measured when using the EdgeAndRadius measurement type
5032 class Surface //helper class containing surfaces properties. Used for the FeatureToFeature measurement type
5047 LineKey normal_points; //the line representing the center line of surfaces of type Cylinder or Cone
5078 bool use_explicit_direction; //if true, we are moving the measurement along a specific vector, called explicit_direction
5102 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'
5114 bool highlight_on_mouse_over; //whether measurable geometry should be highlighted on mouse over
5115 HighlightOptionsKit mouse_over_highlight_options; //the options used for mouse over highlighting
5116 HighlightOptionsKit edit_measurement_highlight_options; //the options used for highlighting measurements while editing them
5117 UpdateNotifier highlight_update_notifier; //notifier used to know if the last highlight update has completed
5119 bool disable_highlighting; //in some situation we temporarily disable highlighting to improve performance
5120 bool Highlight(MeasurementType in_measurement_type, WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path);
5123 bool InputDown(WindowPoint const & in_location, WindowKey & in_window, KeyPath const & in_path, size_t number_of_clicks);
5130 bool InsertEdgeRadiusMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_edge_key);
5131 bool InsertFeatureToFeatureMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window);
5132 void InsertFeatureToFeatureGeometry(Point const & point_one, Point const & point_two, float distance);
5133 bool InsertAngleMeasurement(KeyPath const & in_selection_path, WindowPoint & in_selection_position, Key const & in_face_key, WindowKey & in_window, SelectionResults const & in_selection_results);
5162 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);
5163 Point ClosestPointOnTriangleToPoint(Point const & p, Point const & a, Point const & b, Point const & c);
5164 float ClosestPointSegmentSegment(Point const & p1, Point const & q1, Point const & p2, Point const & q2, Point & c1, Point & c2);
5166 Point GetPlaneIntersection(Plane const & in_plane, KeyPath const & in_key_path, WindowPoint const & in_window_point);
Definition: hps.h:6171
Definition: sprk_exchange.h:3834
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3588
Definition: sprk_exchange.h:43
Definition: sprk_exchange.h:4819
Definition: sprk_exchange.h:935
Definition: sprk.h:237
Definition: sprk_exchange.h:1100
Definition: sprk_exchange.h:4716
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:5680
Definition: sprk.h:66
Definition: sprk.h:100
Definition: sprk_exchange.h:583
Definition: sprk_exchange.h:3028
Definition: sprk_exchange.h:842
Definition: sprk_exchange.h:682
virtual HPS::UTF8 GetName() const OVERRIDE
Definition: sprk_exchange.h:4735
HPS::Type ObjectType() const
Definition: sprk_exchange.h:664
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4471
Definition: hps.h:1663
HPS::Type ObjectType() const
Definition: sprk_exchange.h:710
Definition: sprk_exchange.h:4455
Definition: hps.h:44747
Definition: hps.h:7680
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3850
Definition: hps.h:15670
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3411
Definition: sprk_exchange.h:446
Definition: sprk_exchange.h:530
Definition: sprk_exchange.h:296
virtual HPS::UTF8 GetName() const OVERRIDE
Definition: sprk_exchange.h:4965
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3705
MeasurementInsertedEvent(Event const &in_event)
Definition: sprk_exchange.h:4793
Definition: sprk_exchange.h:1315
Definition: sprk_exchange.h:237
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4209
Definition: sprk_exchange.h:4773
Definition: sprk_exchange.h:3572
HPS::Type ObjectType() const
Definition: sprk_exchange.h:2815
Definition: hps.h:39051
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1054
Definition: sprk_exchange.h:3294
Definition: sprk_exchange.h:2793
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4006
MeasurementInsertedEvent()
Definition: sprk_exchange.h:4777
Definition: sprk_exchange.h:818
Definition: sprk_exchange.h:4193
Definition: sprk_exchange.h:110
Definition: sprk_exchange.h:907
Definition: hps.h:4334
Definition: hps.h:7053
Definition: hps.h:44138
Definition: sprk_exchange.h:401
Definition: hps.h:40980
Definition: hps.h:44534
Definition: sprk_exchange.h:4355
Definition: sprk_exchange.h:880
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3310
Definition: hps.h:15084
Event * Clone() const
Definition: sprk_exchange.h:4855
Definition: sprk_exchange.h:1000
Definition: sprk.h:1636
Definition: hps.h:44857
Definition: hps.h:41960
Definition: hps.h:43803
Definition: sprk_exchange.h:490
Definition: hps.h:6271
Definition: hps.h:13390
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4588
Definition: sprk_exchange.h:4949
Definition: sprk.h:445
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1561
Definition: sprk_parasolid.h:39
Definition: sprk.h:1902
Definition: sprk_exchange.h:3395
HPS::Type ObjectType() const
Definition: sprk_exchange.h:1337
MeasurementDeletedEvent(Event const &in_event)
Definition: sprk_exchange.h:4839
Definition: sprk.h:2213
Definition: sprk_exchange.h:1539
HPS::Type ObjectType() const
Definition: sprk_exchange.h:3050
HPS::Type ObjectType() const
Definition: sprk_exchange.h:611
Definition: sprk.h:2312
Definition: hps.h:7599
Definition: sprk_exchange.h:954
Event * Clone() const
Definition: sprk_exchange.h:4809
HPS::Type ObjectType() const
Definition: sprk_exchange.h:4371
Definition: hps.h:9179
HPS::Type ObjectType() const
Definition: sprk_exchange.h:204
Definition: sprk_exchange.h:636
Definition: hps.h:23017
Definition: sprk.h:2398
Definition: hps.h:29247
Definition: sprk_exchange.h:1017
Definition: hps.h:515
Definition: sprk.h:1065
Definition: sprk_exchange.h:2748
MeasurementDeletedEvent()
Definition: sprk_exchange.h:4823
static Model CreateModel(char const *in_name="")
Definition: sprk_exchange.h:3689
Definition: sprk_exchange.h:172
Definition: hps.h:38548
Definition: sprk_exchange.h:4572
HPS::Type ObjectType() const
Definition: sprk_exchange.h:558
Definition: hps.h:39645
Definition: sprk_exchange.h:3990