MeshLib C++ Docs
Loading...
Searching...
No Matches

#include <MRMesh/MRObjectPoints.h>

Inheritance diagram for MR::ObjectPoints:

Public Member Functions

 ObjectPoints ()=default
 ObjectPoints (const ObjectMesh &objMesh, bool saveNormals=true)
ObjectPointsoperator= (ObjectPoints &&)=default
 ObjectPoints (ObjectPoints &&)=default
virtual const char * typeName () const override
virtual std::string className () const override
virtual std::string classNameInPlural () const override
virtual const std::shared_ptr< PointCloud > & varPointCloud ()
 returns variable point cloud, if const point cloud is needed use pointCloud() instead
virtual std::shared_ptr< Objectclone () const override
virtual std::shared_ptr< ObjectshallowClone () const override
virtual void setPointCloud (const std::shared_ptr< PointCloud > &pointCloud)
virtual void swapPointCloud (std::shared_ptr< PointCloud > &points)
 ObjectPoints (ProtectedStruct, const ObjectPoints &obj)
virtual 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::ObjectPointsHolder
 ObjectPointsHolder ()
 ObjectPointsHolder (ObjectPointsHolder &&) noexcept=default
ObjectPointsHolderoperator= (ObjectPointsHolder &&) noexcept=default
virtual void applyScale (float scaleFactor) override
 scale object size (all point positions)
virtual bool hasVisualRepresentation () const override
 does the object have any visual representation (visible points, triangles, edges, etc.), no considering child objects
virtual bool hasModel () const override
const std::shared_ptr< const PointCloud > & pointCloud () const
PointCloudPart pointCloudPart () const
 reinterpret_cast to avoid making a copy of shared_ptr
virtual void setDirtyFlags (uint32_t mask, bool invalidateCaches=true) override
const VertBitSet & getSelectedPoints () const
 gets current selected points
void selectPoints (VertBitSet newSelection)
 sets current selected points
virtual void updateSelectedPoints (VertBitSet &selection)
 swaps current selected points with the argument
const VertBitSet & getSelectedPointsOrAll () const
 returns selected points if any, otherwise returns all valid points
const ColorgetSelectedVerticesColor (ViewportId id={}) const
 returns colors of selected vertices
virtual void setSelectedVerticesColor (const Color &color, ViewportId id={})
 sets colors of selected vertices
const ViewportProperty< Color > & getSelectedVerticesColorsForAllViewports () const
virtual void setSelectedVerticesColorsForAllViewports (ViewportProperty< Color > val)
void copyAllSolidColors (const ObjectPointsHolder &other)
 set all object solid colors (front/back/etc.) from other object for all viewports
bool supportsVisualizeProperty (AnyVisualizeMaskEnum type) const override
 Returns true if this class supports the property type. Otherwise passing it to the functions below is illegal.
const VertColors & getVertsColorMap () const
 returns per-point colors of the object
virtual void setVertsColorMap (VertColors vertsColorMap)
 sets per-point colors of the object
virtual void updateVertsColorMap (VertColors &vertsColorMap)
 swaps per-point colors of the object with given argument
virtual void copyColors (const ObjectPointsHolder &src, const VertMap &thisToSrc, const FaceMap &thisToSrcFaces={})
 copies point colors from given source object
AllVisualizeProperties getAllVisualizeProperties () const override
 get all visualize properties masks
const ViewportMaskgetVisualizePropertyMask (AnyVisualizeMaskEnum type) const override
 returns mask of viewports where given property is set
virtual void setPointSize (float size)
 sets size of points on screen in pixels
virtual float getPointSize () const
 returns size of points on screen in pixels
 ObjectPointsHolder (ProtectedStruct, const ObjectPointsHolder &obj)
virtual Box3f getWorldBox (ViewportId={}) const override
size_t numValidPoints () const
 returns cached information about the number of valid points
size_t numSelectedPoints () const
 returns cached information about the number of selected points
virtual size_t heapBytes () const override
 returns the amount of memory this object occupies on heap
int getRenderDiscretization () const
size_t numRenderingValidPoints () const
 returns count of valid points that will be rendered
int getMaxRenderingPoints () const
void setMaxRenderingPoints (int val)
const char * serializeFormat () const
 returns overriden file extension used to serialize point cloud inside this object, nullptr means defaultSerializePointsFormat()
MR_BIND_IGNORE const char * savePointsFormat () const
void setSerializeFormat (const char *newFormat)
MR_BIND_IGNORE void setSavePointsFormat (const char *newFormat)
void resetFrontColor () override
 reset basic object colors to their default values from the current theme
void resetColors () override
 reset all object colors to their default values from the current theme
Public Member Functions inherited from MR::VisualObject
 VisualObject ()
 VisualObject (VisualObject &&)=default
VisualObjectoperator= (VisualObject &&)=default
virtual ~VisualObject ()=default
void setVisualizeProperty (bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
 set visual property in all viewports specified by the mask
virtual void setVisualizePropertyMask (AnyVisualizeMaskEnum type, ViewportMask viewportMask)
 set visual property mask
bool getVisualizeProperty (AnyVisualizeMaskEnum type, ViewportMask viewportMask) const
 returns true if the property is set at least in one viewport specified by the mask
void toggleVisualizeProperty (AnyVisualizeMaskEnum type, ViewportMask viewportMask)
 toggle visual property in all viewports specified by the mask
void setAllVisualizeProperties (const AllVisualizeProperties &properties)
 set all visualize properties masks
void copyAllSolidColors (const VisualObject &other)
 set all object solid colors (front/back/etc.) from other object for all viewports
ViewportMask globalClippedByPlaneMask () const
 returns all viewports where this object or any of its parents is clipped by plane
bool globalClippedByPlane (ViewportMask viewportMask=ViewportMask::any()) const
 returns true if this object or any of its parents is clipped by plane in any of given viewports
void setGlobalClippedByPlane (bool on, ViewportMask viewportMask=ViewportMask::all())
 if false deactivates clipped-by-plane for this object and all of its parents, otherwise sets clipped-by-plane for this this object only
void showName (bool on)
 shows/hides object name in all viewports
bool showName () const
 returns whether object name is shown in any viewport
const ColorgetFrontColor (bool selected=true, ViewportId viewportId={}) const
 returns color of object when it is selected/not-selected (depending on argument) in given viewport
virtual 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 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 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 const ViewportProperty< Color > & getBackColorsForAllViewports () const
 returns backward color of object in all viewports
virtual void setBackColorsForAllViewports (ViewportProperty< Color > val)
 sets backward color of object in all viewports
const ColorgetBackColor (ViewportId viewportId={}) const
 returns backward color of object in given viewport
virtual void setBackColor (const Color &color, ViewportId viewportId={})
 sets backward color of object in given viewport
const uint8_t & getGlobalAlpha (ViewportId viewportId={}) const
 returns global transparency alpha of object in given viewport
virtual void setGlobalAlpha (uint8_t alpha, ViewportId viewportId={})
 sets global transparency alpha of object in given viewport
virtual const ViewportProperty< uint8_t > & getGlobalAlphaForAllViewports () const
 returns global transparency alpha of object in all viewports
virtual void setGlobalAlphaForAllViewports (ViewportProperty< uint8_t > val)
 sets global transparency alpha of object in all viewports
uint32_t getDirtyFlags () const
 returns current dirty flags for the object
void resetDirty () const
 resets all dirty flags (except for cache flags that will be reset automatically on cache update)
virtual void resetDirtyExceptMask (uint32_t mask) const
 reset dirty flags without some specific bits (useful for lazy normals update)
Box3f getBoundingBox () const
 returns cached bounding box of this object in local coordinates
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 void setPickable (bool on, ViewportMask viewportMask=ViewportMask::all())
 sets the object as can/cannot be picked (by mouse) in all of given viewports
ColoringType getColoringType () const
 returns the current coloring mode of the object
virtual void setColoringType (ColoringType coloringType)
 sets coloring mode of the object with given argument
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
virtual bool render (const ModelRenderParams &) const
virtual void renderForPicker (const ModelBaseRenderParams &, unsigned) const
 draws this object for picking
virtual 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()
bool useDefaultScenePropertiesOnDeserialization () const
void setUseDefaultScenePropertiesOnDeserialization (bool useDefaultScenePropertiesOnDeserialization)
Public Member Functions inherited from MR::Object
 Object ()=default
 Object (Object &&) noexcept=default
Objectoperator= (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)
std::shared_ptr< const Objectfind (const std::string_view &name) const
 finds a direct child by name
std::shared_ptr< Objectfind (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 void setXf (const AffineXf3f &xf, ViewportId id={})
virtual 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
AffineXf3f worldXf (ViewportId id={}, bool *isDef=nullptr) const
void setWorldXf (const AffineXf3f &xf, ViewportId id={})
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
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 Objectparent () const
 returns parent object in the tree
Objectparent ()
bool isAncestor (const Object *ancestor) const
 return true if given object is ancestor of this one, false otherwise
ObjectfindCommonAncestor (Object &other)
const ObjectfindCommonAncestor (const Object &other) const
virtual 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 bool addChild (std::shared_ptr< Object > child, bool recognizedChild=true)
virtual 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 bool removeChild (Object *child)
virtual void removeAllChildren ()
 detaches all recognized children from this, keeping all unrecognized ones
void sortChildren ()
 sort recognized children by name
virtual bool select (bool on)
 selects the object, returns true if value changed, otherwise returns false
virtual bool isSelected () const
virtual void setAncillary (bool ancillary)
bool isAncillary () const
bool isGlobalAncillary () const
 returns true if the object or any of its ancestors are ancillary
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 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
std::shared_ptr< ObjectcloneTree () const
 clones all tree of this object (except ancillary and unrecognized children)
std::shared_ptr< ObjectshallowCloneTree () const
MR_BIND_IGNORE Expected< std::vector< std::future< Expected< void > > > > serializeRecursive (const std::filesystem::path &path, Json::Value &root, int childId) const
Expected< void > deserializeRecursive (const std::filesystem::path &path, const Json::Value &root, ProgressCallback progressCb={}, int *objCounter=nullptr)
void swap (Object &other)
Box3f getWorldTreeBox (ViewportId={}) const
 returns bounding box of this object and all children visible in given (or default) viewport in world coordinates
const std::set< std::string > & tags () const
bool addTag (std::string tag)
bool removeTag (const std::string &tag)
virtual bool sameModels (const Object &other) const
 return true if model of current object equals to model (the same) of other
virtual size_t getModelHash () const
 return hash of model (or hash object pointer if object has no model)
 Object (ProtectedStruct, const Object &obj)
Public Member Functions inherited from MR::ObjectChildrenHolder
 ObjectChildrenHolder ()=default
 ObjectChildrenHolder (const ObjectChildrenHolder &) noexcept
ObjectChildrenHolderoperator= (const ObjectChildrenHolder &) noexcept
 ObjectChildrenHolder (ObjectChildrenHolder &&) noexcept
ObjectChildrenHolderoperator= (ObjectChildrenHolder &&) noexcept
 ~ObjectChildrenHolder ()
std::shared_ptr< ObjectgetSharedPtr () const
size_t heapBytes () const

Static Public Member Functions

static constexpr const char * StaticTypeName () noexcept
static constexpr const char * StaticClassName () noexcept
static constexpr const char * StaticClassNameInPlural () noexcept
Static Public Member Functions inherited from MR::ObjectPointsHolder
static constexpr const char * StaticTypeName () noexcept
Static Public Member Functions inherited from MR::VisualObject
static constexpr const char * StaticTypeName () noexcept
static constexpr const char * StaticClassName () noexcept
static constexpr const char * StaticClassNameInPlural () noexcept
Static Public Member Functions inherited from MR::Object
static constexpr const char * StaticTypeName () noexcept
 return name of subtype for serialization purposes
static constexpr const char * StaticClassName () noexcept
 return human readable name of subclass
static constexpr const char * StaticClassNameInPlural () noexcept
 return human readable name of subclass in plural form

Protected Member Functions

 ObjectPoints (const ObjectPoints &other)=default
virtual void swapBase_ (Object &other) override
 swaps this object with other
virtual void serializeFields_ (Json::Value &root) const override
Protected Member Functions inherited from MR::ObjectPointsHolder
virtual void swapSignals_ (Object &other) override
 ObjectPointsHolder (const ObjectPointsHolder &other)=default
virtual Box3f computeBoundingBox_ () const override
virtual Expected< std::future< Expected< void > > > serializeModel_ (const std::filesystem::path &path) const override
virtual Expected< void > deserializeModel_ (const std::filesystem::path &path, ProgressCallback progressCb={}) override
 Reads model from file.
virtual void deserializeFields_ (const Json::Value &root) override
virtual void setupRenderObject_ () const override
void setAllVisualizeProperties_ (const AllVisualizeProperties &properties, std::size_t &pos) override
 set all visualize properties masks
Protected Member Functions inherited from MR::VisualObject
 VisualObject (const VisualObject &obj)=default
void setDirtyFlagsFast_ (uint32_t mask)
 todo: make virtual and public when all children support separate fast dirty and cache invalidation
void invalidateMetricsCache_ (uint32_t mask)
ViewportMaskgetVisualizePropertyMask_ (AnyVisualizeMaskEnum type)
void deserializeFields_ (const Json::Value &root) override
void boundingBoxToInfoLines_ (std::vector< std::string > &res) const
 adds information about bounding box in res
template<AnyVisualizeMaskEnumType T>
void setAllVisualizePropertiesForEnum (const AllVisualizeProperties &properties, std::size_t &pos)
 Derived classes should use this to implement setAllVisualizeProperties().
template<AnyVisualizeMaskEnumType T>
void getAllVisualizePropertiesForEnum (AllVisualizeProperties &properties) const
 Derived classes should use this to implement getAllVisualizeProperties().
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 Expected< void > setSharedModel_ (const Object &other)
 shares model from other object
void sendWorldXfChangedSignal_ ()
virtual void onWorldXfChanged_ ()
 Emits worldXfChangedSignal, but derived classes can add additional behavior to it.

Additional Inherited Members

Public Types inherited from MR::ObjectPointsHolder
using SelectionChangedSignal = Signal<void()>
 signal about points selection changing, triggered in selectPoints
using ChangedSignal = Signal<void( uint32_t mask )>
 signal about points or normals changing, triggered in setDirtyFlag
Public Types inherited from MR::Object
using XfChangedSignal = Signal<void()>
Public Attributes inherited from MR::ObjectPointsHolder
SelectionChangedSignal pointsSelectionChangedSignal
Signal< void()> renderDiscretizationChangedSignal
 signal about render discretization changing, triggered in setRenderDiscretization
ChangedSignal pointsChangedSignal
ChangedSignal normalsChangedSignal
Public Attributes inherited from MR::Object
XfChangedSignal worldXfChangedSignal
Static Public Attributes inherited from MR::ObjectPointsHolder
static constexpr int MaxRenderingPointsDefault = 1'000'000
 default value for maximum rendered points number
static constexpr int MaxRenderingPointsUnlimited = std::numeric_limits<int>::max()
 recommended value for maximum rendered points number to disable discretization
Protected Attributes inherited from MR::ObjectPointsHolder
VertBitSet selectedPoints_
std::optional< size_t > numValidPoints_
std::optional< size_t > numSelectedPoints_
ViewportProperty< ColorselectedVerticesColor_
ViewportMask showSelectedVertices_ = ViewportMask::all()
VertColors vertsColorMap_
std::shared_ptr< PointCloudpoints_
ViewportProperty< XfBasedCache< Box3f > > worldBox_
float pointSize_ { 5.0f }
 size of point in pixels
int maxRenderingPoints_ = MaxRenderingPointsDefault
Protected Attributes inherited from MR::VisualObject
UniquePtr< IRenderObjectrenderObj_
ViewportMask clipByPlane_
ViewportMask showName_
ViewportMask pickable_ = ViewportMask::all()
 enable picking by gl
ViewportMask depthTest_ = ViewportMask::all()
float shininess_ {35.0f}
 specular exponent
float specularStrength_ { 0.5f }
float ambientStrength_ { 0.1f }
 reflection intensity
ColoringType coloringType_ {ColoringType::SolidColor}
 non - directional light intensity
ViewportProperty< ColorselectedColor_
ViewportProperty< ColorunselectedColor_
ViewportProperty< ColorbackFacesColor_
ViewportProperty< uint8_t > globalAlpha_ { 255 }
bool useDefaultScenePropertiesOnDeserialization_ { false }
Protected Attributes inherited from MR::Object
std::string name_
ViewportProperty< AffineXf3f > xf_
ViewportMask visibilityMask_ = ViewportMask::all()
bool locked_ = false
 Prefer to not read directly. Use the getter, as it can be overridden.
bool parentLocked_ = false
bool selected_ { false }
bool ancillary_ { false }
bool needRedraw_ {false}
std::set< std::string > tags_
Protected Attributes inherited from MR::ObjectChildrenHolder
ObjectChildrenHolderparent_ = nullptr
std::vector< std::shared_ptr< Object > > children_
std::vector< std::weak_ptr< Object > > bastards_
 recognized ones

Detailed Description

an object that stores a points


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