HPS::Exchange::CommonMeasurementOperator

class HPS::Exchange::CommonMeasurementOperator : public HPS::Operator

The CommonMeasurementOperator class defines an operator which contains many often used functions when inserting measurements. Users can build a custom measurement operator by deriving from this class. This operator requires the model be loaded using the Exchange bridge, and the model must contain B-rep.

Subclassed by HPS::Exchange::MeasurementOperator

Public Types

enum Tags

Values:

enumerator Name

enumerator MeasurementType

enumerator Radius

enumerator Inverted

enumerator VectorX

enumerator VectorY

enumerator VectorZ

Public Functions

CommonMeasurementOperator()

CommonMeasurementOperator(Exchange::CADModel const &in_cad_model, MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys())

void DeleteMeasurements(): Deletes all measurements

Exchange::CADModel GetCADModel() const

MaterialMappingKit GetMaterial() const: Returns the material used for the measurements

SegmentKey GetMeasurementSegment() const: Returns the top measurement segment containing all measurements

inline virtual HPS::UTF8 GetName() const override: Returns the name of the operator.

size_t GetPrecision() const: Returns the precision used in the measurement (number of digits after the decimal point)

TextAttributeKit GetTextAttributes() const: Returns the text attributes used for the measurements

virtual void OnViewAttached(HPS::View const &in_attached_view) override

This function is called whenever a view is attached to this operator.

Parameters: in_attached_view – The view attached to this operator.

virtual void OnViewDetached(HPS::View const &in_detached_view) override

This function is called whenever a view is detached from this operator.

Parameters: in_detached_view – The view detached from this operator.

void SetCADModel(Exchange::CADModel const &in_cad_model)

void SetMaterial(MaterialMappingKit const &in_material_mapping): Changes the material used for the measurements. Affects all measurements, even those already inserted.

void SetPrecision(size_t in_precision): Changes the precision used in the measurement (number of digits after the decimal point) Only affects future measurements.

void SetTextAttribute(TextAttributeKit const &in_text_attributes): Changes the text attributes used for the measurements. Affects all measurements, even those already inserted.

Public Static Functions

static UTF8 GetNewMeasurementSegmentName(HPS::UTF8 const &in_prefix): Returns the name to be used for the new measurement segment name

class MeasurementDeletedEvent : public HPS::Event

Public Functions

inline virtual Event *Clone() const

Allocates and returns a copy of this MeasurementDeletedEvent.

Returns: A copy of this MeasurementDeletedEvent.

inline MeasurementDeletedEvent(): The default constructor creates an empty MeasurementDeletedEvent object.

inline MeasurementDeletedEvent(Event const &in_event)

This constructor converts an Event Object to a MeasurementDeletedEvent object.

Parameters: in_event – The Event Object to be converted.

inline MeasurementDeletedEvent(HPS::UTF8 const &in_measurement_name, HPS::View const &in_view)

~MeasurementDeletedEvent()

Public Members

UTF8 measurement_name

View view

class MeasurementInsertedEvent : public HPS::Event

Public Functions

inline virtual Event *Clone() const

Allocates and returns a copy of this MeasurementInsertedEvent.

Returns: A copy of this MeasurementInsertedEvent.

inline MeasurementInsertedEvent(): The default constructor creates an empty MeasurementInsertedEvent object.

inline MeasurementInsertedEvent(Event const &in_event)

This constructor converts an Event Object to a MeasurementInsertedEvent object.

Parameters: in_event – The Event Object to be converted.

inline MeasurementInsertedEvent(HPS::Key const &in_measurement_key, HPS::View const &in_view)

~MeasurementInsertedEvent()

Public Members

Key measurement_key

View view