MR::DistanceMeasurementObject Class Reference

#include <MRDistanceMeasurementObject.h>

Inheritance diagram for MR::DistanceMeasurementObject:

Public Types
enum class	PerCoordDeltas { none , withSign , absolute }
Public Types inherited from MR::Object
using	XfChangedSignal = Signal<void() >

Public Member Functions
	DistanceMeasurementObject ()
	DistanceMeasurementObject (DistanceMeasurementObject &&) noexcept=default
DistanceMeasurementObject &	operator= (DistanceMeasurementObject &&) noexcept=default
const char *	typeName () const override
	DistanceMeasurementObject (ProtectedStruct, const DistanceMeasurementObject &obj)
std::string	getClassName () const override
	return human readable name of subclass
MRMESH_API std::shared_ptr< Object >	clone () const override
MRMESH_API std::shared_ptr< Object >	shallowClone () const override
MRMESH_API Vector3f	getWorldPoint () const
MRMESH_API Vector3f	getLocalPoint () const
MRMESH_API Vector3f	getWorldDelta () const
MRMESH_API Vector3f	getLocalDelta () const
virtual MRMESH_API void	setLocalPoint (const MR::Vector3f &point)
virtual MRMESH_API void	setLocalDelta (const MR::Vector3f &delta)
MRMESH_API bool	getDrawAsNegative () const
virtual MRMESH_API void	setDrawAsNegative (bool value)
MRMESH_API PerCoordDeltas	getPerCoordDeltasMode () const
virtual MRMESH_API void	setPerCoordDeltasMode (PerCoordDeltas mode)
MRMESH_API float	computeDistance () const
MRMESH_API std::vector< std::string >	getInfoLines () const override
	return several info lines that can better describe the object in the UI
Public Member Functions inherited from MR::VisualObject
MRMESH_API	VisualObject ()
	VisualObject (VisualObject &&)=default
VisualObject &	operator= (VisualObject &&)=default
virtual	~VisualObject ()=default
virtual MRMESH_API bool	supportsVisualizeProperty (AnyVisualizeMaskEnum type) const
	Returns true if this class supports the property type. Otherwise passing it to the functions below is illegal.
MRMESH_API void	setVisualizeProperty (bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
	set visual property in all viewports specified by the mask
virtual MRMESH_API void	setVisualizePropertyMask (AnyVisualizeMaskEnum type, ViewportMask viewportMask)
	set visual property mask
MRMESH_API bool	getVisualizeProperty (AnyVisualizeMaskEnum type, ViewportMask viewportMask) const
	returns true if the property is set at least in one viewport specified by the mask
virtual MRMESH_API const ViewportMask &	getVisualizePropertyMask (AnyVisualizeMaskEnum type) const
	returns mask of viewports where given property is set
MRMESH_API void	toggleVisualizeProperty (AnyVisualizeMaskEnum type, ViewportMask viewportMask)
	toggle visual property in all viewports specified by the mask
virtual MRMESH_API AllVisualizeProperties	getAllVisualizeProperties () const
	get all visualize properties masks
void	setAllVisualizeProperties (const AllVisualizeProperties &properties)
	set all visualize properties masks
void	showLabels (bool on)
	shows/hides labels
bool	showLabels () const
void	showName (bool on)
	shows/hides object name in all viewports
bool	showName () const
	returns whether object name is shown in any viewport
MRMESH_API const Color &	getFrontColor (bool selected=true, ViewportId viewportId={}) const
	returns color of object when it is selected/not-selected (depending on argument) in given viewport
virtual MRMESH_API void	setFrontColor (const Color &color, bool selected, ViewportId viewportId={})
	sets color of object when it is selected/not-selected (depending on argument) in given viewport
virtual MRMESH_API const ViewportProperty< Color > &	getFrontColorsForAllViewports (bool selected=true) const
	returns color of object when it is selected/not-selected (depending on argument) in all viewports
virtual MRMESH_API void	setFrontColorsForAllViewports (ViewportProperty< Color > val, bool selected=true)
	sets color of object when it is selected/not-selected (depending on argument) in all viewports
virtual MRMESH_API const ViewportProperty< Color > &	getBackColorsForAllViewports () const
	returns backward color of object in all viewports
virtual MRMESH_API void	setBackColorsForAllViewports (ViewportProperty< Color > val)
	sets backward color of object in all viewports
MRMESH_API const Color &	getBackColor (ViewportId viewportId={}) const
	returns backward color of object in given viewport
virtual MRMESH_API void	setBackColor (const Color &color, ViewportId viewportId={})
	sets backward color of object in given viewport
MRMESH_API const uint8_t &	getGlobalAlpha (ViewportId viewportId={}) const
	returns global transparency alpha of object in given viewport
virtual MRMESH_API void	setGlobalAlpha (uint8_t alpha, ViewportId viewportId={})
	sets global transparency alpha of object in given viewport
virtual MRMESH_API const ViewportProperty< uint8_t > &	getGlobalAlphaForAllViewports () const
	returns global transparency alpha of object in all viewports
virtual MRMESH_API void	setGlobalAlphaForAllViewports (ViewportProperty< uint8_t > val)
	sets global transparency alpha of object in all viewports
MRMESH_API const Color &	getLabelsColor (ViewportId viewportId={}) const
virtual MRMESH_API void	setLabelsColor (const Color &color, ViewportId viewportId={})
MRMESH_API const ViewportProperty< Color > &	getLabelsColorsForAllViewports () const
virtual MRMESH_API void	setLabelsColorsForAllViewports (ViewportProperty< Color > val)
virtual MRMESH_API void	setDirtyFlags (uint32_t mask, bool invalidateCaches=true)
MRMESH_API uint32_t	getDirtyFlags () const
	returns current dirty flags for the object
MRMESH_API void	resetDirty () const
	resets all dirty flags (except for cache flags that will be reset automatically on cache update)
MRMESH_API Box3f	getBoundingBox () const
	returns cached bounding box of this object in local coordinates
virtual MRMESH_API Box3f	getWorldBox (ViewportId={}) const override
virtual bool	getRedrawFlag (ViewportMask viewportMask) const override
	returns true if the object must be redrawn (due to dirty flags) in one of specified viewports
bool	isPickable (ViewportMask viewportMask=ViewportMask::any()) const
	whether the object can be picked (by mouse) in any of given viewports
virtual MRMESH_API void	setPickable (bool on, ViewportMask viewportMask=ViewportMask::all())
	sets the object as can/cannot be picked (by mouse) in all of given viewports
const VertColors &	getVertsColorMap () const
	returns per-vertex colors of the object
virtual void	setVertsColorMap (VertColors vertsColorMap)
	sets per-vertex colors of the object
virtual void	updateVertsColorMap (VertColors &vertsColorMap)
	swaps per-vertex colors of the object with given argument
ColoringType	getColoringType () const
	returns the current coloring mode of the object
virtual MRMESH_API void	setColoringType (ColoringType coloringType)
	sets coloring mode of the object with given argument
virtual MRMESH_API void	copyColors (const VisualObject &src, const VertMap &thisToSrc, const FaceMap &thisToSrcFaces={})
	copies point colors from given source object
float	getShininess () const
	returns the current shininess visual value
virtual void	setShininess (float shininess)
	sets shininess visual value of the object with given argument
float	getSpecularStrength () const
	returns intensity of reflections
virtual void	setSpecularStrength (float specularStrength)
	sets intensity of reflections
float	getAmbientStrength () const
	returns intensity of non-directional light
virtual void	setAmbientStrength (float ambientStrength)
	sets intensity of non-directional light
const std::vector< PositionedText > &	getLabels () const
virtual void	setLabels (std::vector< PositionedText > labels)
virtual MRMESH_API bool	render (const ModelRenderParams &) const
virtual MRMESH_API void	renderForPicker (const ModelBaseRenderParams &, unsigned) const
	draws this object for picking
virtual MRMESH_API void	renderUi (const UiRenderParams &params) const
	draws this object for 2d UI
	VisualObject (ProtectedStruct, const VisualObject &obj)
	this ctor is public only for std::make_shared used inside clone()
virtual MRMESH_API size_t	heapBytes () const override
	returns the amount of memory this object occupies on heap
MRMESH_API bool	useDefaultScenePropertiesOnDeserialization () const
MRMESH_API void	setUseDefaultScenePropertiesOnDeserialization (bool useDefaultScenePropertiesOnDeserialization)
Public Member Functions inherited from MR::Object
	Object ()=default
	Object (Object &&) noexcept=default
Object &	operator= (Object &&) noexcept=default
virtual	~Object ()=default
template<typename T >
T *	asType ()
template<typename T >
const T *	asType () const
const std::string &	name () const
virtual void	setName (std::string name)
MRMESH_API std::shared_ptr< const Object >	find (const std::string_view &name) const
	finds a direct child by name
std::shared_ptr< Object >	find (const std::string_view &name)
template<typename T >
std::shared_ptr< const T >	find () const
	finds a direct child by type
template<typename T >
std::shared_ptr< T >	find ()
template<typename T >
std::shared_ptr< const T >	find (const std::string_view &name) const
	finds a direct child by name and type
template<typename T >
std::shared_ptr< T >	find (const std::string_view &name)
const AffineXf3f &	xf (ViewportId id={}, bool *isDef=nullptr) const
virtual MRMESH_API void	setXf (const AffineXf3f &xf, ViewportId id={})
virtual MRMESH_API void	resetXf (ViewportId id={})
	forgets specific transform in given viewport (or forgets all specific transforms for {} input)
const ViewportProperty< AffineXf3f > &	xfsForAllViewports () const
	returns xfs for all viewports, combined into a single object
virtual void	setXfsForAllViewports (ViewportProperty< AffineXf3f > xf)
	modifies xfs for all viewports at once
MRMESH_API AffineXf3f	worldXf (ViewportId id={}, bool *isDef=nullptr) const
MRMESH_API void	setWorldXf (const AffineXf3f &xf, ViewportId id={})
virtual MRMESH_API void	applyScale (float scaleFactor)
	scale object size (all point positions)
MRMESH_API ViewportMask	globalVisibilityMask () const
	returns all viewports where this object is visible together with all its parents
bool	globalVisibility (ViewportMask viewportMask=ViewportMask::any()) const
	returns true if this object is visible together with all its parents in any of given viewports
MRMESH_API void	setGlobalVisibility (bool on, ViewportMask viewportMask=ViewportMask::any())
	if true sets all predecessors visible, otherwise sets this object invisible
bool	isLocked () const
	object properties lock for UI
virtual void	setLocked (bool on)
bool	isParentLocked () const
virtual void	setParentLocked (bool lock)
const Object *	parent () const
	returns parent object in the tree
Object *	parent ()
MRMESH_API bool	isAncestor (const Object *ancestor) const
	return true if given object is ancestor of this one, false otherwise
MRMESH_API Object *	findCommonAncestor (Object &other)
const Object *	findCommonAncestor (const Object &other) const
virtual MRMESH_API bool	detachFromParent ()
const std::vector< std::shared_ptr< Object > > &	children ()
	an object can hold other sub-objects
const std::vector< std::shared_ptr< const Object > > &	children () const
virtual MRMESH_API bool	addChild (std::shared_ptr< Object > child, bool recognizedChild=true)
virtual MRMESH_API bool	addChildBefore (std::shared_ptr< Object > newChild, const std::shared_ptr< Object > &existingChild)
bool	removeChild (const std::shared_ptr< Object > &child)
	returns false if it was not child of this
virtual MRMESH_API bool	removeChild (Object *child)
virtual MRMESH_API void	removeAllChildren ()
	detaches all recognized children from this, keeping all unrecognized ones
MRMESH_API void	sortChildren ()
	sort recognized children by name
virtual MRMESH_API bool	select (bool on)
	selects the object, returns true if value changed, otherwise returns false
virtual bool	isSelected () const
virtual MRMESH_API void	setAncillary (bool ancillary)
bool	isAncillary () const
MRMESH_API void	setVisible (bool on, ViewportMask viewportMask=ViewportMask::all())
	sets the object visible in the viewports specified by the mask (by default in all viewports)
bool	isVisible (ViewportMask viewportMask=ViewportMask::any()) const
	checks whether the object is visible in any of the viewports specified by the mask (by default in any viewport)
virtual MRMESH_API void	setVisibilityMask (ViewportMask viewportMask)
	specifies object visibility as bitmask of viewports
virtual ViewportMask	visibilityMask () const
	gets object visibility as bitmask of viewports
void	resetRedrawFlag () const
MRMESH_API std::shared_ptr< Object >	cloneTree () const
	clones all tree of this object (except ancillary and unrecognized children)
MRMESH_API std::shared_ptr< Object >	shallowCloneTree () const
MRMESH_API Expected< std::vector< std::future< Expected< void > > > >	serializeRecursive (const std::filesystem::path &path, Json::Value &root, int childId) const
MRMESH_API Expected< void >	deserializeRecursive (const std::filesystem::path &path, const Json::Value &root, ProgressCallback progressCb={}, int *objCounter=nullptr)
MRMESH_API void	swap (Object &other)
MRMESH_API Box3f	getWorldTreeBox (ViewportId={}) const
	returns bounding box of this object and all children visible in given (or default) viewport in world coordinates
virtual bool	hasVisualRepresentation () const
	does the object have any visual representation (visible points, triangles, edges, etc.), no considering child objects
virtual bool	hasModel () const
	Object (ProtectedStruct, const Object &obj)
Public Member Functions inherited from MR::ObjectChildrenHolder
	ObjectChildrenHolder ()=default
	ObjectChildrenHolder (const ObjectChildrenHolder &) noexcept
ObjectChildrenHolder &	operator= (const ObjectChildrenHolder &) noexcept
MRMESH_API	ObjectChildrenHolder (ObjectChildrenHolder &&) noexcept
MRMESH_API ObjectChildrenHolder &	operator= (ObjectChildrenHolder &&) noexcept
MRMESH_API	~ObjectChildrenHolder ()
MRMESH_API std::shared_ptr< Object >	getSharedPtr () const
MRMESH_API size_t	heapBytes () const

Static Public Member Functions
static constexpr const char *	TypeName () noexcept
Static Public Member Functions inherited from MR::VisualObject
static constexpr const char *	TypeName () noexcept
Static Public Member Functions inherited from MR::Object
static constexpr const char *	TypeName () noexcept

Protected Member Functions
	DistanceMeasurementObject (const DistanceMeasurementObject &other)=default
MRMESH_API void	swapBase_ (Object &other) override
	swaps this object with other
MRMESH_API void	serializeFields_ (Json::Value &root) const override
MRMESH_API void	deserializeFields_ (const Json::Value &root) override
MRMESH_API void	setupRenderObject_ () const override
MRMESH_API void	propagateWorldXfChangedSignal_ () override
Protected Member Functions inherited from MR::MeasurementObject
MRMESH_API	MeasurementObject ()
Protected Member Functions inherited from MR::VisualObject
	VisualObject (const VisualObject &obj)=default
MRMESH_API ViewportMask &	getVisualizePropertyMask_ (AnyVisualizeMaskEnum type)
MRMESH_API void	deserializeFields_ (const Json::Value &root) override
virtual Box3f	computeBoundingBox_ () const
MRMESH_API void	boundingBoxToInfoLines_ (std::vector< std::string > &res) const
	adds information about bounding box in res
virtual MRMESH_API void	setAllVisualizeProperties_ (const AllVisualizeProperties &properties, std::size_t &pos)
template<AnyVisualizeMaskEnumType T>
void	setAllVisualizePropertiesForEnum (const AllVisualizeProperties &properties, std::size_t &pos)
template<AnyVisualizeMaskEnumType T>
void	getAllVisualizePropertiesForEnum (AllVisualizeProperties &properties) const
Protected Member Functions inherited from MR::Object
	Object (const Object &obj)=default
	user should not be able to call copy implicitly, use clone() function instead
virtual MRMESH_API void	swapSignals_ (Object &other)
virtual MRMESH_API Expected< std::future< Expected< void > > >	serializeModel_ (const std::filesystem::path &path) const
virtual MRMESH_API Expected< void >	deserializeModel_ (const std::filesystem::path &path, ProgressCallback progressCb={})
	Reads model from file.

Additional Inherited Members
Public Attributes inherited from MR::Object
XfChangedSignal	worldXfChangedSignal
Protected Attributes inherited from MR::VisualObject
UniquePtr< IRenderObject >	renderObj_
Dirty	dirty_
ViewportMask	clipByPlane_
ViewportMask	showLabels_
ViewportMask	showName_
ViewportMask	cropLabels_ = ViewportMask::all()
ViewportMask	pickable_ = ViewportMask::all()
	enable picking by gl
ViewportMask	invertNormals_
	invert mesh normals
ViewportMask	depthTest_ = ViewportMask::all()
ViewportProperty< Color >	labelsColor_ = {}
float	shininess_ {35.0f}
	specular exponent
float	specularStrength_ { 0.5f }
float	ambientStrength_ { 0.1f }
ColoringType	coloringType_ {ColoringType::SolidColor}
	Main coloring options.
VertColors	vertsColorMap_
ViewportProperty< Color >	selectedColor_
ViewportProperty< Color >	unselectedColor_
ViewportProperty< Color >	backFacesColor_
ViewportProperty< uint8_t >	globalAlpha_ { 255 }
std::vector< PositionedText >	labels_
bool	useDefaultScenePropertiesOnDeserialization_ { false }
Protected Attributes inherited from MR::Object
std::string	name_
ViewportProperty< AffineXf3f >	xf_
ViewportMask	visibilityMask_ = ViewportMask::all()
bool	locked_ = false
bool	parentLocked_ = false
bool	selected_ { false }
bool	ancillary_ { false }
bool	needRedraw_ {false}
Protected Attributes inherited from MR::ObjectChildrenHolder
ObjectChildrenHolder *	parent_ = nullptr
std::vector< std::shared_ptr< Object > >	children_
std::vector< std::weak_ptr< Object > >	bastards_
	recognized ones

Member Enumeration Documentation

PerCoordDeltas

enum class MR::DistanceMeasurementObject::PerCoordDeltas

strong

Enumerator
none
withSign
absolute

Constructor & Destructor Documentation

DistanceMeasurementObject() [1/4]

MR::DistanceMeasurementObject::DistanceMeasurementObject ( )

inline

DistanceMeasurementObject() [2/4]

MR::DistanceMeasurementObject::DistanceMeasurementObject ( DistanceMeasurementObject && )

defaultnoexcept

DistanceMeasurementObject() [3/4]

MR::DistanceMeasurementObject::DistanceMeasurementObject ( ProtectedStruct , const DistanceMeasurementObject & obj )

inline

DistanceMeasurementObject() [4/4]

MR::DistanceMeasurementObject::DistanceMeasurementObject ( const DistanceMeasurementObject & other )

protecteddefault

Member Function Documentation

clone()

MRMESH_API std::shared_ptr< Object > MR::DistanceMeasurementObject::clone ( ) const

overridevirtual

clones this object only, without its children, making new object the owner of all copied resources

Reimplemented from MR::VisualObject.

computeDistance()

MRMESH_API float MR::DistanceMeasurementObject::computeDistance ( ) const

nodiscard

deserializeFields_()

MRMESH_API void MR::DistanceMeasurementObject::deserializeFields_ ( const Json::Value & root )

overrideprotectedvirtual

Reads parameters from json value

Note

if you override this method, please call Base::deserializeFields_(root) in the beginning

Reimplemented from MR::Object.

getClassName()

std::string MR::DistanceMeasurementObject::getClassName ( ) const

inlineoverridevirtual

return human readable name of subclass

Reimplemented from MR::VisualObject.

getDrawAsNegative()

MRMESH_API bool MR::DistanceMeasurementObject::getDrawAsNegative ( ) const

nodiscard

getInfoLines()

MRMESH_API std::vector< std::string > MR::DistanceMeasurementObject::getInfoLines ( ) const

nodiscardoverridevirtual

return several info lines that can better describe the object in the UI

Reimplemented from MR::VisualObject.

getLocalDelta()

MRMESH_API Vector3f MR::DistanceMeasurementObject::getLocalDelta ( ) const

nodiscard

getLocalPoint()

MRMESH_API Vector3f MR::DistanceMeasurementObject::getLocalPoint ( ) const

nodiscard

getPerCoordDeltasMode()

MRMESH_API PerCoordDeltas MR::DistanceMeasurementObject::getPerCoordDeltasMode ( ) const

nodiscard

getWorldDelta()

MRMESH_API Vector3f MR::DistanceMeasurementObject::getWorldDelta ( ) const

nodiscard

getWorldPoint()

MRMESH_API Vector3f MR::DistanceMeasurementObject::getWorldPoint ( ) const

nodiscard

operator=()

DistanceMeasurementObject & MR::DistanceMeasurementObject::operator= ( DistanceMeasurementObject && )

defaultnoexcept

propagateWorldXfChangedSignal_()

MRMESH_API void MR::DistanceMeasurementObject::propagateWorldXfChangedSignal_ ( )

overrideprotectedvirtual

Reimplemented from MR::Object.

serializeFields_()

MRMESH_API void MR::DistanceMeasurementObject::serializeFields_ ( Json::Value & root ) const

overrideprotectedvirtual

Write parameters to given Json::Value,

Note

if you override this method, please call Base::serializeFields_(root) in the beginning

Reimplemented from MR::VisualObject.

setDrawAsNegative()

virtual MRMESH_API void MR::DistanceMeasurementObject::setDrawAsNegative ( bool value )

virtual

setLocalDelta()

virtual MRMESH_API void MR::DistanceMeasurementObject::setLocalDelta ( const MR::Vector3f & delta )

virtual

setLocalPoint()

virtual MRMESH_API void MR::DistanceMeasurementObject::setLocalPoint ( const MR::Vector3f & point )

virtual

setPerCoordDeltasMode()

virtual MRMESH_API void MR::DistanceMeasurementObject::setPerCoordDeltasMode ( PerCoordDeltas mode )

virtual

setupRenderObject_()

MRMESH_API void MR::DistanceMeasurementObject::setupRenderObject_ ( ) const

overrideprotectedvirtual

each renderable child of VisualObject should implement this method and assign renderObj_ inside

Reimplemented from MR::VisualObject.

shallowClone()

MRMESH_API std::shared_ptr< Object > MR::DistanceMeasurementObject::shallowClone ( ) const

overridevirtual

clones this object only, without its children, making new object to share resources with this object

Reimplemented from MR::VisualObject.

swapBase_()

MRMESH_API void MR::DistanceMeasurementObject::swapBase_ ( Object & other )

overrideprotectedvirtual

swaps this object with other

Reimplemented from MR::VisualObject.

TypeName()

static constexpr const char * MR::DistanceMeasurementObject::TypeName ( )

inlinestaticconstexprnoexcept

typeName()

const char * MR::DistanceMeasurementObject::typeName ( ) const

inlineoverridevirtual

Reimplemented from MR::VisualObject.

---

The documentation for this class was generated from the following file:

• MRDistanceMeasurementObject.h