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

#include <MRMesh/MRObjectMeshHolder.h>

Inheritance diagram for MR::ObjectMeshHolder:

Public Types

using SelectionChangedSignal = Signal<void()>
 signal about face selection changing, triggered in selectFaces
using MeshChangedSignal = Signal<void( uint32_t mask )>
 signal about mesh changing, triggered in setDirtyFlag
Public Types inherited from MR::Object
using XfChangedSignal = Signal<void()>

Public Member Functions

 ObjectMeshHolder ()
 ObjectMeshHolder (ObjectMeshHolder &&) noexcept=default
ObjectMeshHolderoperator= (ObjectMeshHolder &&) noexcept=default
virtual const char * typeName () const override
virtual void applyScale (float scaleFactor) override
 scale object size (all point positions)
virtual bool hasVisualRepresentation () const override
 mesh object can be seen if the mesh has at least one edge
virtual bool hasModel () const override
const std::shared_ptr< const Mesh > & mesh () const
MeshPart meshPart () const
 reinterpret_cast to avoid making a copy of shared_ptr
virtual std::shared_ptr< Objectclone () const override
virtual std::shared_ptr< ObjectshallowClone () const override
virtual void setDirtyFlags (uint32_t mask, bool invalidateCaches=true) override
virtual void setDirtyFlagsFast (uint32_t mask)
virtual void invalidateMetricsCache (uint32_t mask)
 invalidates same caches with mesh metrics (area, volume, ...) as by setDirtyFlags( mask )
const FaceBitSet & getSelectedFaces () const
virtual void selectFaces (FaceBitSet newSelection)
const ColorgetSelectedFacesColor (ViewportId id={}) const
 returns colors of selected triangles
virtual void setSelectedFacesColor (const Color &color, ViewportId id={})
 sets colors of selected triangles
const UndirectedEdgeBitSet & getSelectedEdges () const
virtual void selectEdges (UndirectedEdgeBitSet newSelection)
const ColorgetSelectedEdgesColor (ViewportId id={}) const
 returns colors of selected edges
virtual void setSelectedEdgesColor (const Color &color, ViewportId id={})
 sets colors of selected edges
const ViewportProperty< Color > & getSelectedEdgesColorsForAllViewports () const
virtual void setSelectedEdgesColorsForAllViewports (ViewportProperty< Color > val)
const ViewportProperty< Color > & getSelectedFacesColorsForAllViewports () const
virtual void setSelectedFacesColorsForAllViewports (ViewportProperty< Color > val)
const ViewportProperty< Color > & getEdgesColorsForAllViewports () const
virtual void setEdgesColorsForAllViewports (ViewportProperty< Color > val)
const ViewportProperty< Color > & getPointsColorsForAllViewports () const
virtual void setPointsColorsForAllViewports (ViewportProperty< Color > val)
const ViewportProperty< Color > & getBordersColorsForAllViewports () const
virtual void setBordersColorsForAllViewports (ViewportProperty< Color > val)
void copyAllSolidColors (const ObjectMeshHolder &other)
 set all object solid colors (front/back/etc.) from other object for all viewports
const UndirectedEdgeBitSet & creases () const
 Edges on mesh, that will have sharp visualization even with smooth shading.
virtual void setCreases (UndirectedEdgeBitSet creases)
void setFlatShading (bool on)
 sets flat (true) or smooth (false) shading
bool flatShading () const
bool supportsVisualizeProperty (AnyVisualizeMaskEnum type) const override
 Returns true if this class supports the property type. Otherwise passing it to the functions below is illegal.
AllVisualizeProperties getAllVisualizeProperties () const override
 get all visualize properties masks
const ViewportMaskgetVisualizePropertyMask (AnyVisualizeMaskEnum type) const override
 returns mask of viewports where given property is set
const ObjectMeshDatadata () const
 provides read-only access to whole ObjectMeshData
virtual void setData (ObjectMeshData &&data)
 sets whole new ObjectMeshData
virtual void updateData (ObjectMeshData &data)
 swaps whole ObjectMeshData with given argument
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
const FaceColors & getFacesColorMap () const
virtual void setFacesColorMap (FaceColors facesColorMap)
virtual void updateFacesColorMap (FaceColors &updated)
virtual void setEdgeWidth (float edgeWidth)
float getEdgeWidth () const
virtual void setPointSize (float size)
virtual float getPointSize () const
const ColorgetEdgesColor (ViewportId id={}) const
virtual void setEdgesColor (const Color &color, ViewportId id={})
const ColorgetPointsColor (ViewportId id={}) const
virtual void setPointsColor (const Color &color, ViewportId id={})
const ColorgetBordersColor (ViewportId id={}) const
virtual void setBordersColor (const Color &color, ViewportId id={})
 ObjectMeshHolder (ProtectedStruct, const ObjectMeshHolder &obj)
const MeshTexturegetTexture () const
 returns first texture in the vector. If there is no textures, returns empty texture
virtual MR_BIND_IGNORE void setTexture (MeshTexture texture)
 for backward compatibility
virtual MR_BIND_IGNORE void updateTexture (MeshTexture &updated)
const Vector< MeshTexture, TextureId > & getTextures () const
virtual void setTextures (Vector< MeshTexture, TextureId > texture)
virtual void updateTextures (Vector< MeshTexture, TextureId > &updated)
virtual void setTexturePerFace (Vector< TextureId, FaceId > texturePerFace)
virtual void updateTexturePerFace (Vector< TextureId, FaceId > &texturePerFace)
virtual void addTexture (MeshTexture texture)
const TexturePerFace & getTexturePerFace () const
const VertUVCoords & getUVCoords () const
virtual void setUVCoords (VertUVCoords uvCoordinates)
virtual void updateUVCoords (VertUVCoords &updated)
virtual void copyTextureAndColors (const ObjectMeshHolder &src, const VertMap &thisToSrc, const FaceMap &thisToSrcFaces={})
 copies texture, UV-coordinates and vertex colors from given source object
virtual void copyColors (const ObjectMeshHolder &src, const VertMap &thisToSrc, const FaceMap &thisToSrcFaces={})
 copies vertex colors from given source object
const MeshTexturegetAncillaryTexture () const
 ancillary texture can be used to have custom features visualization without affecting real one
virtual void setAncillaryTexture (MeshTexture texture)
const VertUVCoords & getAncillaryUVCoords () const
virtual void setAncillaryUVCoords (VertUVCoords uvCoordinates)
void updateAncillaryUVCoords (VertUVCoords &updated)
bool hasAncillaryTexture () const
void clearAncillaryTexture ()
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 isMeshClosed () const
 returns cached information whether the mesh is closed
virtual Box3f getWorldBox (ViewportId={}) const override
size_t numSelectedFaces () const
 returns cached information about the number of selected faces in the mesh
size_t numSelectedEdges () const
 returns cached information about the number of selected undirected edges in the mesh
size_t numCreaseEdges () const
 returns cached information about the number of crease undirected edges in the mesh
double totalArea () const
 returns cached summed area of mesh triangles
double selectedArea () const
 returns cached area of selected triangles
double volume () const
 returns cached volume of space surrounded by the mesh, which is valid only if mesh is closed
float avgEdgeLen () const
 returns cached average edge length
size_t numUndirectedEdges () const
 returns cached information about the number of undirected edges in the mesh
size_t numHoles () const
 returns cached information about the number of holes in the mesh
size_t numComponents () const
 returns cached information about the number of components in the mesh
size_t numHandles () const
 returns cached information about the number of handles in the mesh
virtual size_t heapBytes () const override
 returns the amount of memory this object occupies on heap
const char * serializeFormat () const
 returns overriden file extension used to serialize mesh inside this object, nullptr means defaultSerializeMeshFormat()
const char * actualSerializeFormat () const
 returns overriden file extension used to serialize mesh inside this object if set, or defaultSerializeMeshFormat().c_str() otherwise; never returns nullptr
void setSerializeFormat (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
virtual size_t getModelHash () const override
 return hash of model (or hash object pointer if object has no model)
virtual bool sameModels (const Object &other) const override
 return true if model of current object equals to model (the same) of other
Public Member Functions inherited from MR::VisualObject
 VisualObject ()
 VisualObject (VisualObject &&)=default
VisualObjectoperator= (VisualObject &&)=default
virtual ~VisualObject ()=default
virtual std::string className () const override
virtual std::string classNameInPlural () const override
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
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()
virtual std::vector< std::string > getInfoLines () const override
 return several info lines that can better describe the object in the UI
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)
 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 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

Public Attributes

SelectionChangedSignal faceSelectionChangedSignal
SelectionChangedSignal edgeSelectionChangedSignal
SelectionChangedSignal creasesChangedSignal
MeshChangedSignal meshChangedSignal
Public Attributes inherited from MR::Object
XfChangedSignal worldXfChangedSignal

Protected Member Functions

 ObjectMeshHolder (const ObjectMeshHolder &other)=default
virtual void swapBase_ (Object &other) override
 swaps this object with other
virtual void swapSignals_ (Object &other) override
virtual Expected< std::future< Expected< void > > > serializeModel_ (const std::filesystem::path &path) const override
virtual void serializeFields_ (Json::Value &root) const override
void deserializeFields_ (const Json::Value &root) override
Expected< void > deserializeModel_ (const std::filesystem::path &path, ProgressCallback progressCb={}) override
 Reads model from file.
virtual Expected< void > setSharedModel_ (const Object &other) override
 shares model from other object
void setAllVisualizeProperties_ (const AllVisualizeProperties &properties, std::size_t &pos) override
 set all visualize properties masks
virtual Box3f computeBoundingBox_ () const override
virtual void setupRenderObject_ () const override
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
void sendWorldXfChangedSignal_ ()
virtual void onWorldXfChanged_ ()
 Emits worldXfChangedSignal, but derived classes can add additional behavior to it.

Protected Attributes

ObjectMeshData data_
Vector< MeshTexture, TextureId > textures_
 Texture options.
MeshTexture ancillaryTexture_
VertUVCoords ancillaryUVCoordinates_
 vertices coordinates in ancillary texture
std::optional< size_t > numHoles_
std::optional< size_t > numComponents_
std::optional< size_t > numUndirectedEdges_
std::optional< size_t > numHandles_
std::optional< bool > meshIsClosed_
std::optional< size_t > numSelectedFaces_
std::optional< size_t > numSelectedEdges_
std::optional< size_t > numCreaseEdges_
std::optional< double > totalArea_
std::optional< double > selectedArea_
std::optional< double > volume_
std::optional< float > avgEdgeLen_
ViewportProperty< XfBasedCache< Box3f > > worldBox_
ViewportMask showTexture_
ViewportMask showFaces_ = ViewportMask::all()
ViewportMask showEdges_
ViewportMask showPoints_
ViewportMask showSelectedEdges_ = ViewportMask::all()
ViewportMask showSelectedFaces_ = ViewportMask::all()
ViewportMask showBordersHighlight_
ViewportMask polygonOffset_
ViewportMask flatShading_
 toggle per-face or per-vertex properties
ViewportMask shadingEnabled_ = ViewportMask::all()
ViewportMask onlyOddFragments_
ViewportProperty< ColoredgesColor_
ViewportProperty< ColorpointsColor_
ViewportProperty< ColorbordersColor_
ViewportProperty< ColoredgeSelectionColor_
ViewportProperty< ColorfaceSelectionColor_
float edgeWidth_ { 0.5f }
float pointSize_ { 5.f }
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 mesh


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