An interface class which allows feature objects to share setters and getters on their main properties, for convenient presentation in the UI.
More...
|
| virtual const char * | typeName () const override |
| virtual std::string | className () const override |
| virtual std::string | classNameInPlural () const override |
| virtual const std::vector< FeatureObjectSharedProperty > & | getAllSharedProperties () const =0 |
| | Create and generate list of bounded getters and setters for the main properties of feature object, together with prop. name for display and edit into UI.
|
| 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 ViewportMask & | getVisualizePropertyMask (AnyVisualizeMaskEnum type) const override |
| | returns mask of viewports where given property is set
|
| void | serializeFields_ (Json::Value &root) const override |
| void | deserializeFields_ (const Json::Value &root) override |
| virtual FeatureObjectProjectPointResult | projectPoint (const Vector3f &point, ViewportId id={}) const =0 |
| std::optional< Vector3f > | getNormal (const Vector3f &point) const |
| void | setXf (const AffineXf3f &xf, ViewportId id={}) override |
| void | resetXf (ViewportId id={}) override |
| | forgets specific transform in given viewport (or forgets all specific transforms for {} input)
|
| virtual Vector3f | getBasePoint (ViewportId id={}) const |
| | Returns point considered as base for the feature.
|
| Matrix3f | getRotationMatrix (ViewportId id={}, bool *isDef=nullptr) const |
| Matrix3f | getScaleShearMatrix (ViewportId id={}, bool *isDef=nullptr) const |
| const Color & | getDecorationsColor (bool selected, ViewportId viewportId={}, bool *isDef=nullptr) const |
| virtual void | setDecorationsColor (const Color &color, bool selected, ViewportId viewportId={}) |
| virtual const ViewportProperty< Color > & | getDecorationsColorForAllViewports (bool selected) const |
| virtual void | setDecorationsColorForAllViewports (ViewportProperty< Color > val, bool selected) |
| virtual float | getPointSize () const |
| | Point size and line width, for primary rendering rather than subfeatures.
|
| virtual float | getLineWidth () const |
| virtual void | setPointSize (float pointSize) |
| virtual void | setLineWidth (float lineWidth) |
| virtual float | getSubfeaturePointSize () const |
| | Point size and line width, for subfeatures rather than primary rendering.
|
| virtual float | getSubfeatureLineWidth () const |
| virtual void | setSubfeaturePointSize (float pointSize) |
| virtual void | setSubfeatureLineWidth (float lineWidth) |
| virtual float | getMainFeatureAlpha () const |
| | Per-component alpha multipliers. The global alpha is multiplied by thise.
|
| virtual float | getSubfeatureAlphaPoints () const |
| virtual float | getSubfeatureAlphaLines () const |
| virtual float | getSubfeatureAlphaMesh () const |
| virtual void | setMainFeatureAlpha (float alpha) |
| virtual void | setSubfeatureAlphaPoints (float alpha) |
| virtual void | setSubfeatureAlphaLines (float alpha) |
| virtual void | setSubfeatureAlphaMesh (float alpha) |
| | VisualObject () |
| | VisualObject (VisualObject &&)=default |
| VisualObject & | operator= (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 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 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 Color & | getBackColor (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
|
| virtual void | setDirtyFlags (uint32_t mask, bool invalidateCaches=true) |
| 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 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 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 std::shared_ptr< Object > | clone () const override |
| virtual std::shared_ptr< Object > | shallowClone () const override |
| virtual bool | render (const ModelRenderParams &) const |
| virtual void | renderForPicker (const ModelBaseRenderParams &, unsigned) const |
| | draws this object for picking
|
| virtual void | renderUi (const UiRenderParams ¶ms) 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 size_t | heapBytes () const override |
| | returns the amount of memory this object occupies on heap
|
| 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) |
| virtual void | resetFrontColor () |
| | reset basic object colors to their default values from the current theme
|
| virtual void | resetColors () |
| | reset all object colors to their default values from the current theme
|
| | 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) |
| 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 |
| 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={}) |
| virtual void | applyScale (float scaleFactor) |
| | scale object size (all point positions)
|
| 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 Object * | parent () const |
| | returns parent object in the tree
|
| Object * | parent () |
| bool | isAncestor (const Object *ancestor) const |
| | return true if given object is ancestor of this one, false otherwise
|
| Object * | findCommonAncestor (Object &other) |
| const Object * | findCommonAncestor (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< Object > | cloneTree () const |
| | clones all tree of this object (except ancillary and unrecognized children)
|
| std::shared_ptr< Object > | shallowCloneTree () 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
|
| virtual bool | hasVisualRepresentation () const |
| | does the object have any visual representation (visible points, triangles, edges, etc.), no considering child objects
|
| virtual bool | hasModel () const |
| 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) |
| | ObjectChildrenHolder ()=default |
| | ObjectChildrenHolder (const ObjectChildrenHolder &) noexcept |
| ObjectChildrenHolder & | operator= (const ObjectChildrenHolder &) noexcept |
| | ObjectChildrenHolder (ObjectChildrenHolder &&) noexcept |
| ObjectChildrenHolder & | operator= (ObjectChildrenHolder &&) noexcept |
| | ~ObjectChildrenHolder () |
| std::shared_ptr< Object > | getSharedPtr () const |
| size_t | heapBytes () const |
1.14.0 