The MeasurementOperator class defines an operator which allows the user to insert measurements into the scene This operator requires the model be loaded using the Exchange bridge, and the model must contain B-rep.The behavior of the operator, and its usage, vary based on the type of measurement the user wishes to insert.Point to Point measurement: The Point to Point measurement mode allows the user to measure the distance between two arbitrary points. Usage:Click where you want to insert the first measurement point.Click where you want to insert the second measurement pointMove the mouse to move the measurement geometry around.Click to position the measurement.Edge and Radius measurement: The Edge and Radius measurement mode allows the user to measure the length of an edge, or the radius of a circle, based on whether the edge clicked on is a line or a circle. Usage:Click on the edge you want to measureMove the mouse to move the measurement geometry around.Click again to position the measurement.If the edge you clicked on is part of a cir cle, the circle radius will be measured, otherwise the edge length will be measured.Feature to Feature measurement: The Feature to Feature measurement mode allows the user to measure the shortest distance between two features. Usage:Click on a faceClick on a different faceMove the mouse to move the measurement geometry around.Click again to position the measurement.If both faces are planar, the shortest distance between them is measuredIf one face is planar and the other is id conical or cylindrical, the shortest distance between the center line and the face is measuredIf both faces are conical or cylindrical, the shortest distance between the two center lines is measuredFace Angle measurement: The Face Angle measurement mode allows the user to measure the angle between two planar, non-parallel faces. Usage:Click on a faceClick on a different face, which is not parallel to the first faceMove the mouse to move the measurement geometry around.Click again to position the measurement.Once a measurement has been inserted, its position can be modified by clicking on it, moving the mouse, and clicking once more once it is in the desired position. Pressing Escape will delete the measurement currently being inserted.The operator will inject an Event of type MeasurementInsertedEvent every time a new measurement is inserted. The user can handle this event to obtain the segment key associated with every inserted measurement.A valid CADModel needs to be passed to the constructor of this class. More...

Public Types | |
enum | MeasurementType { PointToPoint = 0, EdgeAndRadius = 1, FeatureToFeature = 2, FaceAngle = 3 } |
![]() | |
enum | Tags { Name = 0, MeasurementType = 1, Radius = 2, Inverted = 3, VectorX = 4, VectorY = 5, VectorZ = 6 } |
![]() | |
enum | Priority { Low = 0, Default = 1, High = 2 } |
Public Member Functions | |
override void | Dispose () |
HPS.HighlightOptionsKit | GetHighlightOptions () |
HPS.Exchange.MeasurementOperator.MeasurementType | GetMeasurementType () |
Returns the type of measurement the operator is currently set up to insert. More... | |
bool | GetMouseOverHighlighting () |
override string | GetName () |
Returns the name of the operator. More... | |
bool | IsMeasurementActive () |
MeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
MeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger) | |
MeasurementOperator (HPS.Exchange.CADModel in_cad_model) | |
MeasurementOperator (HPS.Exchange.MeasurementOperator in_that) | |
delegate int | MeasurementOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str) |
delegate void | MeasurementOperatorDelegate_1 () |
delegate bool | MeasurementOperatorDelegate_10 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_11 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_12 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_13 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_14 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_15 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_16 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_17 (string in_text) |
delegate bool | MeasurementOperatorDelegate_18 (IntPtr in_event) |
delegate void | MeasurementOperatorDelegate_19 () |
delegate void | MeasurementOperatorDelegate_2 () |
delegate void | MeasurementOperatorDelegate_20 () |
delegate bool | MeasurementOperatorDelegate_21 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_22 () |
delegate void | MeasurementOperatorDelegate_23 () |
delegate bool | MeasurementOperatorDelegate_3 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_4 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_5 (IntPtr in_state) |
delegate bool | MeasurementOperatorDelegate_6 (IntPtr in_state) |
delegate HPS.Type | MeasurementOperatorDelegate_7 () |
delegate void | MeasurementOperatorDelegate_8 (IntPtr in_that) |
delegate bool | MeasurementOperatorDelegate_9 (IntPtr in_that) |
override bool | OnKeyDown (HPS.KeyboardState in_state) |
This function is called whenever HPS receives a KeyDownEvent that signals a key was pressed. Pressing Escape while in the process of inserting a measurement deletes that measurement. More... | |
override bool | OnMouseDown (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. This function inserts the measuring points. More... | |
override bool | OnMouseMove (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved When the user has just inserted the second measurement point, this function allows the user to move the measurement geometry along a specific vector. If the user has selected an already existing measurement, this function allows the measurement geometry to be moved anywhere in the view plane. More... | |
override bool | OnMouseUp (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. More... | |
override void | OnViewAttached () |
This function is called whenever a view is attached to this operator. More... | |
override void | OnViewDetached () |
This function is called whenever a view is detached from this operator. More... | |
void | SetMeasurementType (HPS.Exchange.MeasurementOperator.MeasurementType in_measurement_type) |
void | SetMouseOverHighlighting (bool in_highlighting) |
void | SetMouseOverHighlighting (bool in_highlighting, HPS.HighlightOptionsKit in_highlight_options_kit) |
![]() | |
CommonMeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
CommonMeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger) | |
CommonMeasurementOperator (HPS.Exchange.CADModel in_cad_model) | |
CommonMeasurementOperator (HPS.Exchange.CommonMeasurementOperator in_that) | |
delegate int | CommonMeasurementOperatorDelegate_0 (int ret_maxsize, IntPtr ret_str) |
delegate void | CommonMeasurementOperatorDelegate_1 () |
delegate bool | CommonMeasurementOperatorDelegate_10 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_11 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_12 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_13 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_14 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_15 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_16 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_17 (string in_text) |
delegate bool | CommonMeasurementOperatorDelegate_18 (IntPtr in_event) |
delegate void | CommonMeasurementOperatorDelegate_19 () |
delegate void | CommonMeasurementOperatorDelegate_2 () |
delegate void | CommonMeasurementOperatorDelegate_20 () |
delegate bool | CommonMeasurementOperatorDelegate_21 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_22 () |
delegate void | CommonMeasurementOperatorDelegate_23 () |
delegate HPS.Type | CommonMeasurementOperatorDelegate_3 () |
delegate void | CommonMeasurementOperatorDelegate_4 (IntPtr in_that) |
delegate bool | CommonMeasurementOperatorDelegate_5 (IntPtr in_that) |
delegate bool | CommonMeasurementOperatorDelegate_6 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_7 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_8 (IntPtr in_state) |
delegate bool | CommonMeasurementOperatorDelegate_9 (IntPtr in_state) |
void | DeleteMeasurements () |
HPS.Exchange.CADModel | GetCADModel () |
HPS.MaterialMappingKit | GetMaterial () |
Returns the material used for the measurements More... | |
HPS.SegmentKey | GetMeasurementSegment () |
Returns the top measurement segment containing all measurements More... | |
ulong | GetPrecision () |
Returns the precision used in the measurement (number of digits after the decimal point) More... | |
HPS.TextAttributeKit | GetTextAttributes () |
Returns the text attributes used for the measurements More... | |
void | SetCADModel (HPS.Exchange.CADModel in_cad_model) |
void | SetMaterial (HPS.MaterialMappingKit in_material_mapping) |
Changes the material used for the measurements. Affects all measurements, even those already inserted. More... | |
void | SetPrecision (ulong in_precision) |
Changes the precision used in the measurement (number of digits after the decimal point) Only affects future measurements. More... | |
void | SetTextAttribute (HPS.TextAttributeKit in_text_attributes) |
Changes the text attributes used for the measurements. Affects all measurements, even those already inserted. More... | |
![]() | |
virtual void | Assign (HPS.Operator in_that) |
Assigns the parameter in_that to this operator, resulting in a clone. More... | |
void | DetachView () |
Detaches the Operator from the View it was previously attached to. More... | |
delegate void | DtorDelegate (IntPtr cPtr) |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.Operator in_that) |
Tests this operator for equality against the parameter in_that. Same as Operator::operator== More... | |
HPS.View | GetAttachedView () |
Returns the View the Operator is currently attached to. More... | |
override int | GetHashCode () |
HPS.ModifierKeys | GetModifierTrigger () |
Gets the modifier trigger associated with this operator. More... | |
HPS.MouseButtons | GetMouseTrigger () |
Gets the mouse trigger associated with this operator. More... | |
virtual bool | IsMouseTriggered (HPS.MouseState in_state) |
Returns true if the MouseButtons and ModifierKeys are active. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
virtual bool | OnKeyUp (HPS.KeyboardState in_state) |
This function is called whenever HPS receives a KeyboardEvent that signals a key was released. More... | |
virtual void | OnModelAttached () |
This function is called whenever a model is attached to the view that is attached to this operator. If no view is attached to this operator, this function will not be called. More... | |
virtual void | OnModelDetached () |
This function is called whenever a model is detached from the view that is attached to this operator. If no view is attached to this operator, this function will not be called. More... | |
virtual bool | OnMouseEnter (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window. More... | |
virtual bool | OnMouseLeave (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse left the window. More... | |
virtual bool | OnMouseWheel (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled. More... | |
virtual bool | OnTextInput (string in_text) |
virtual bool | OnTimerTick (HPS.TimerTickEvent in_event) |
This function is called whenever HPS receives a TimerTickEvent. More... | |
virtual bool | OnTouchDown (HPS.TouchState in_state) |
This function is called whenever HPS receives a TouchEvent that signals the device was touched. More... | |
virtual bool | OnTouchMove (HPS.TouchState in_state) |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. More... | |
virtual bool | OnTouchUp (HPS.TouchState in_state) |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released. More... | |
Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
Operator (HPS.MouseButtons in_mouse_trigger) | |
Operator (HPS.Operator in_that) | |
delegate HPS.Type | OperatorDelegate_0 () |
delegate void | OperatorDelegate_1 (IntPtr in_that) |
delegate bool | OperatorDelegate_10 (IntPtr in_state) |
delegate bool | OperatorDelegate_11 (IntPtr in_state) |
delegate bool | OperatorDelegate_12 (IntPtr in_state) |
delegate bool | OperatorDelegate_13 (IntPtr in_state) |
delegate bool | OperatorDelegate_14 (IntPtr in_state) |
delegate bool | OperatorDelegate_15 (string in_text) |
delegate bool | OperatorDelegate_16 (IntPtr in_event) |
delegate void | OperatorDelegate_17 () |
delegate void | OperatorDelegate_18 () |
delegate void | OperatorDelegate_19 () |
delegate bool | OperatorDelegate_2 (IntPtr in_that) |
delegate void | OperatorDelegate_20 () |
delegate bool | OperatorDelegate_21 (IntPtr in_state) |
delegate bool | OperatorDelegate_22 () |
delegate void | OperatorDelegate_23 () |
delegate int | OperatorDelegate_3 (int ret_maxsize, IntPtr ret_str) |
delegate bool | OperatorDelegate_4 (IntPtr in_state) |
delegate bool | OperatorDelegate_5 (IntPtr in_state) |
delegate bool | OperatorDelegate_6 (IntPtr in_state) |
delegate bool | OperatorDelegate_7 (IntPtr in_state) |
delegate bool | OperatorDelegate_8 (IntPtr in_state) |
delegate bool | OperatorDelegate_9 (IntPtr in_state) |
void | SetModifierTrigger (HPS.ModifierKeys in_modifiers) |
Sets the modifier trigger associated with this operator. More... | |
void | SetMouseTrigger (HPS.MouseButtons in_buttons) |
Sets the mouse trigger for this operator More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
override IntPtr | GetNonDirectorClassID () |
![]() | |
void | DtorCallback (IntPtr p) |
Additional Inherited Members | |
![]() | |
static string | GetNewMeasurementSegmentName (string in_prefix) |
![]() | |
static bool | operator!= (HPS.Operator a, HPS.Operator b) |
static bool | operator== (HPS.Operator a, HPS.Operator b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
Detailed Description
The MeasurementOperator class defines an operator which allows the user to insert measurements into the scene This operator requires the model be loaded using the Exchange bridge, and the model must contain B-rep.The behavior of the operator, and its usage, vary based on the type of measurement the user wishes to insert.Point to Point measurement: The Point to Point measurement mode allows the user to measure the distance between two arbitrary points. Usage:Click where you want to insert the first measurement point.Click where you want to insert the second measurement pointMove the mouse to move the measurement geometry around.Click to position the measurement.Edge and Radius measurement: The Edge and Radius measurement mode allows the user to measure the length of an edge, or the radius of a circle, based on whether the edge clicked on is a line or a circle. Usage:Click on the edge you want to measureMove the mouse to move the measurement geometry around.Click again to position the measurement.If the edge you clicked on is part of a cir cle, the circle radius will be measured, otherwise the edge length will be measured.Feature to Feature measurement: The Feature to Feature measurement mode allows the user to measure the shortest distance between two features. Usage:Click on a faceClick on a different faceMove the mouse to move the measurement geometry around.Click again to position the measurement.If both faces are planar, the shortest distance between them is measuredIf one face is planar and the other is id conical or cylindrical, the shortest distance between the center line and the face is measuredIf both faces are conical or cylindrical, the shortest distance between the two center lines is measuredFace Angle measurement: The Face Angle measurement mode allows the user to measure the angle between two planar, non-parallel faces. Usage:Click on a faceClick on a different face, which is not parallel to the first faceMove the mouse to move the measurement geometry around.Click again to position the measurement.Once a measurement has been inserted, its position can be modified by clicking on it, moving the mouse, and clicking once more once it is in the desired position. Pressing Escape will delete the measurement currently being inserted.The operator will inject an Event of type MeasurementInsertedEvent every time a new measurement is inserted. The user can handle this event to obtain the segment key associated with every inserted measurement.A valid CADModel needs to be passed to the constructor of this class.
Member Function Documentation
|
inline |
Returns the type of measurement the operator is currently set up to insert.
- Returns
- The type of measurement the operator is currently set up to insert.
|
inlinevirtual |
Returns the name of the operator.
Reimplemented from HPS.Exchange.CommonMeasurementOperator.
|
inlinevirtual |
This function is called whenever HPS receives a KeyDownEvent that signals a key was pressed. Pressing Escape while in the process of inserting a measurement deletes that measurement.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. This function inserts the measuring points.
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved When the user has just inserted the second measurement point, this function allows the user to move the measurement geometry along a specific vector. If the user has selected an already existing measurement, this function allows the measurement geometry to be moved anywhere in the view plane.
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
|
inlinevirtual |
This function is called whenever a view is attached to this operator.
Reimplemented from HPS.Exchange.CommonMeasurementOperator.
|
inlinevirtual |
This function is called whenever a view is detached from this operator.
Reimplemented from HPS.Exchange.CommonMeasurementOperator.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs