qCC_db version 2.13.alpha (Qt) - 31 May 2022
CloudCompare 3D entities
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ccGenericPointCloud Class Referenceabstract

A 3D cloud interface with associated features (color, normals, octree, etc.) More...

#include <ccGenericPointCloud.h>

Inheritance diagram for ccGenericPointCloud:
Inheritance graph
[legend]
Collaboration diagram for ccGenericPointCloud:
Collaboration graph
[legend]

Public Types

using VisibilityTableType = std::vector< unsigned char >
 Array of "visibility" information for each point. More...
 
- Public Types inherited from ccHObject
enum  DEPENDENCY_FLAGS {
  DP_NONE = 0 , DP_NOTIFY_OTHER_ON_DELETE = 1 , DP_NOTIFY_OTHER_ON_UPDATE = 2 , DP_DELETE_OTHER = 8 ,
  DP_PARENT_OF_OTHER = 24
}
 Dependency flags. More...
 
enum  SelectionBehavior { SELECTION_AA_BBOX , SELECTION_FIT_BBOX , SELECTION_IGNORED }
 Behavior when selected.
 
using Container = std::vector< ccHObject * >
 Standard instances container (for children, etc.)
 
using Shared = QSharedPointer< ccHObject >
 Shared pointer.
 
using SharedContainer = std::vector< Shared >
 Shared instances container (for children, etc.)
 
using GlobalBoundingBox = CCCoreLib::BoundingBoxTpl< double >
 Global (non-shifted) bounding-box.
 
- Public Types inherited from ccSerializableObject
enum  DeserializationFlags { DF_POINT_COORDS_64_BITS = 1 , DF_SCALAR_VAL_32_BITS = 2 }
 Deserialization flags (bit-field) More...
 
typedef QMultiMap< unsigned, unsigned > LoadedIDMap
 Map of loaded unique IDs (old ID --> new ID)
 

Public Member Functions

 ccGenericPointCloud (QString name=QString(), unsigned uniqueID=ccUniqueIDGenerator::InvalidUniqueID)
 Default constructor. More...
 
 ccGenericPointCloud (const ccGenericPointCloud &cloud)
 Copy constructor.
 
 ~ccGenericPointCloud () override
 Default destructor.
 
virtual ccGenericPointCloudclone (ccGenericPointCloud *destCloud=nullptr, bool ignoreChildren=false)=0
 Clones this entity. More...
 
virtual void clear ()
 Clears the entity from all its points and features. More...
 
virtual ccOctree::Shared computeOctree (CCCoreLib::GenericProgressCallback *progressCb=nullptr, bool autoAddChild=true)
 Computes the cloud octree. More...
 
virtual ccOctree::Shared getOctree () const
 Returns the associated octree (if any)
 
virtual void setOctree (ccOctree::Shared octree, bool autoAddChild=true)
 Sets the associated octree.
 
virtual ccOctreeProxygetOctreeProxy () const
 Returns the associated octree proxy (if any)
 
virtual void deleteOctree ()
 Erases the octree.
 
virtual const ccColor::RgbgeScalarValueColor (ScalarType d) const =0
 Returns color corresponding to a given scalar value. More...
 
virtual const ccColor::RgbgetPointScalarValueColor (unsigned pointIndex) const =0
 Returns color corresponding to a given point associated scalar value. More...
 
virtual ScalarType getPointDisplayedDistance (unsigned pointIndex) const =0
 Returns scalar value associated to a given point. More...
 
virtual const ccColor::RgbagetPointColor (unsigned pointIndex) const =0
 Returns color corresponding to a given point. More...
 
virtual const CompressedNormType & getPointNormalIndex (unsigned pointIndex) const =0
 Returns compressed normal corresponding to a given point. More...
 
virtual const CCVector3 & getPointNormal (unsigned pointIndex) const =0
 Returns normal corresponding to a given point. More...
 
virtual VisibilityTableTypegetTheVisibilityArray ()
 Returns associated visibility array.
 
virtual const VisibilityTableTypegetTheVisibilityArray () const
 Returns associated visibility array (const version)
 
virtual CCCoreLib::ReferenceCloud * getTheVisiblePoints (const VisibilityTableType *visTable=nullptr, bool silent=false) const
 Returns a ReferenceCloud equivalent to the visibility array. More...
 
virtual bool isVisibilityTableInstantiated () const
 Returns whether the visibility array is allocated or not.
 
virtual bool resetVisibilityArray ()
 Resets the associated visibility array. More...
 
virtual void invertVisibilityArray ()
 Inverts the visibility array.
 
virtual void unallocateVisibilityArray ()
 Erases the points visibility information.
 
ccBBox getOwnBB (bool withGLFeatures=false) override
 Returns the entity's own bounding-box (with local/shifted coordinates) More...
 
virtual void refreshBB ()=0
 Forces bounding-box update.
 
virtual ccGenericPointCloudcreateNewCloudFromVisibilitySelection (bool removeSelectedPoints=false, VisibilityTableType *visTable=nullptr, bool silent=false)=0
 Creates a new point cloud with only the 'visible' points (as defined by the visibility array) More...
 
virtual void applyRigidTransformation (const ccGLMatrix &trans)=0
 Applies a rigid transformation (rotation + translation)
 
virtual CCCoreLib::ReferenceCloud * crop (const ccBBox &box, bool inside=true)=0
 Crops the cloud inside (or outside) a bounding box. More...
 
virtual void scale (PointCoordinateType fx, PointCoordinateType fy, PointCoordinateType fz, CCVector3 center=CCVector3(0, 0, 0))=0
 Multiplies all coordinates by constant factors (one per dimension) More...
 
bool isSerializable () const override
 Returns whether object is serializable of not. More...
 
void setPointSize (unsigned size=0)
 Sets point size. More...
 
unsigned char getPointSize () const
 Returns current point size. More...
 
void importParametersFrom (const ccGenericPointCloud *cloud)
 Imports the parameters from another cloud. More...
 
bool pointPicking (const CCVector2d &clickPos, const ccGLCameraParameters &camera, int &nearestPointIndex, double &nearestSquareDist, double pickWidth=2.0, double pickHeight=2.0, bool autoComputeOctree=false)
 Point picking (brute force or octree-driven) More...
 
- Public Member Functions inherited from ccShiftedObject
 ccShiftedObject (QString name=QString(), unsigned uniqueID=ccUniqueIDGenerator::InvalidUniqueID)
 Default constructor. More...
 
 ccShiftedObject (const ccShiftedObject &s)=default
 Copy constructor. More...
 
void copyGlobalShiftAndScale (const ccShiftedObject &s)
 Copies the Global Shift and Scale from another entity. More...
 
virtual void setGlobalShift (double x, double y, double z)
 Sets shift applied to original coordinates (information storage only) More...
 
virtual void setGlobalShift (const CCVector3d &shift)
 Sets shift applied to original coordinates (information storage only) More...
 
virtual const CCVector3d & getGlobalShift () const
 Returns the shift applied to original coordinates. More...
 
virtual void setGlobalScale (double scale)
 Sets the scale applied to original coordinates (information storage only) More...
 
virtual double getGlobalScale () const
 Returns the scale applied to original coordinates. More...
 
bool isShifted () const
 Returns whether the cloud is shifted or not.
 
template<typename T >
CCVector3d toGlobal3d (const Vector3Tpl< T > &Plocal) const
 Returns the point back-projected into the original coordinates system.
 
template<typename T >
CCVector3d toLocal3d (const Vector3Tpl< T > &Pglobal) const
 Returns the point projected into the local (shifted) coordinates system.
 
template<typename T >
CCVector3 toLocal3pc (const Vector3Tpl< T > &Pglobal) const
 Returns the point projected into the local (shifted) coordinates system.
 
bool getOwnGlobalBB (CCVector3d &minCorner, CCVector3d &maxCorner) override
 Returns the entity's own global bounding-box (with global/non-shifted coordinates - if relevant) More...
 
GlobalBoundingBox getOwnGlobalBB (bool withGLFeatures=false) override
 Returns the entity's own global bounding-box (with global/non-shifted coordinates - if relevant) More...
 
- Public Member Functions inherited from ccHObject
 ccHObject (const QString &name=QString(), unsigned uniqueID=ccUniqueIDGenerator::InvalidUniqueID)
 Default constructor. More...
 
 ccHObject (const ccHObject &object)
 Copy constructor.
 
 ~ccHObject () override
 Default destructor.
 
CC_CLASS_ENUM getClassID () const override
 Returns class ID. More...
 
bool isGroup () const
 Returns whether the instance is a group.
 
ccHObjectgetParent () const
 Returns parent object. More...
 
virtual QIcon getIcon () const
 Returns the icon associated to this entity. More...
 
void addDependency (ccHObject *otherObject, int flags, bool additive=true)
 Adds a new dependence (additive or not) More...
 
int getDependencyFlagsWith (const ccHObject *otherObject) const
 Returns the dependency flags with a given object. More...
 
void removeDependencyWith (ccHObject *otherObject)
 Removes any dependency flags with a given object. More...
 
void removeDependencyFlag (ccHObject *otherObject, DEPENDENCY_FLAGS flag)
 Removes a given dependency flag. More...
 
virtual bool addChild (ccHObject *child, int dependencyFlags=DP_PARENT_OF_OTHER, int insertIndex=-1)
 Adds a child. More...
 
unsigned getChildrenNumber () const
 Returns the number of children. More...
 
unsigned int getChildCountRecursive () const
 Returns the total number of children under this object recursively. More...
 
ccHObjectgetChild (unsigned childPos) const
 Returns the ith child. More...
 
ccHObjectfind (unsigned uniqueID) const
 Finds an entity in this object hierarchy. More...
 
unsigned filterChildren (Container &filteredChildren, bool recursive=false, CC_CLASS_ENUM filter=CC_TYPES::OBJECT, bool strict=false, ccGenericGLDisplay *inDisplay=nullptr) const
 Collects the children corresponding to a certain pattern. More...
 
void detachChild (ccHObject *child)
 Detaches a specific child. More...
 
void detachAllChildren ()
 Removes a specific child. More...
 
void removeChild (ccHObject *child)
 
void removeChild (int pos)
 Removes a specific child given its index. More...
 
void removeAllChildren ()
 Removes all children.
 
int getChildIndex (const ccHObject *aChild) const
 Returns child index.
 
void swapChildren (unsigned firstChildIndex, unsigned secondChildIndex)
 Swaps two children.
 
int getIndex () const
 Returns index relatively to its parent or -1 if no parent.
 
void transferChild (ccHObject *child, ccHObject &newParent)
 Transfer a given child to another parent.
 
void transferChildren (ccHObject &newParent, bool forceFatherDependent=false)
 Transfer all children to another parent.
 
ccHObjectgetFirstChild () const
 Shortcut: returns first child.
 
ccHObjectgetLastChild () const
 Shortcut: returns last child.
 
bool isAncestorOf (const ccHObject *anObject) const
 Returns true if the current object is an ancestor of the specified one.
 
virtual ccBBox getOwnBB (bool withGLFeatures=false)
 Returns the entity's own bounding-box (with local/shifted coordinates) More...
 
virtual ccBBox getBB_recursive (bool withGLFeatures=false, bool onlyEnabledChildren=true)
 Returns the local bounding-box of this entity and it's children. More...
 
virtual GlobalBoundingBox getOwnGlobalBB (bool withGLFeatures=false)
 Returns the entity's own global bounding-box (with global/non-shifted coordinates - if relevant) More...
 
virtual bool getOwnGlobalBB (CCVector3d &minCorner, CCVector3d &maxCorner)
 Returns the entity's own global bounding-box (with global/non-shifted coordinates - if relevant) More...
 
virtual GlobalBoundingBox getGlobalBB_recursive (bool withGLFeatures=false, bool onlyEnabledChildren=true)
 Returns the global bounding-box of this entity and it's children. More...
 
virtual ccBBox getDisplayBB_recursive (bool relative, const ccGenericGLDisplay *display=nullptr)
 Returns the bounding-box of this entity and it's children WHEN DISPLAYED. More...
 
virtual ccBBox getOwnFitBB (ccGLMatrix &trans)
 Returns best-fit bounding-box (if available) More...
 
virtual void drawBB (CC_DRAW_CONTEXT &context, const ccColor::Rgb &col)
 Draws the entity (and its children) bounding-box. More...
 
void draw (CC_DRAW_CONTEXT &context) override
 Draws entity and its children. More...
 
bool getAbsoluteGLTransformation (ccGLMatrix &trans) const
 Returns the absolute transformation (i.e. the actual displayed GL transformation) of an entity. More...
 
virtual bool isDisplayed () const
 Returns whether the object is actually displayed (visible) or not.
 
virtual bool isDisplayedIn (const ccGenericGLDisplay *display) const
 Returns whether the object is actually displayed (visible) in a given display or not.
 
virtual bool isBranchEnabled () const
 Returns whether the object and all its ancestors are enabled.
 
 ccHObject_recursive_call1 (setSelected, bool, setSelected_recursive) ccHObject_recursive_call1(setDisplay
 
ccGenericGLDisplay setDisplay_recursive ccHObject_recursive_call1 (removeFromDisplay, ccGenericGLDisplay *, removeFromDisplay_recursive) ccHObject_recursive_call0(prepareDisplayForRefresh
 
ccGenericGLDisplay setDisplay_recursive prepareDisplayForRefresh_recursive ccHObject_recursive_call1 (refreshDisplay, bool, refreshDisplay_recursive) ccHObject_recursive_call0(resetGLTransformationHistory
 
ccGenericGLDisplay setDisplay_recursive prepareDisplayForRefresh_recursive resetGLTransformationHistory_recursive ccHObject_recursive_call0 (toggleActivation, toggleActivation_recursive) ccHObject_recursive_call0(toggleVisibility
 
ccGenericGLDisplay setDisplay_recursive prepareDisplayForRefresh_recursive resetGLTransformationHistory_recursive toggleVisibility_recursive ccHObject_recursive_call0 (toggleColors, toggleColors_recursive) ccHObject_recursive_call0(toggleNormals
 
ccGenericGLDisplay setDisplay_recursive prepareDisplayForRefresh_recursive resetGLTransformationHistory_recursive toggleVisibility_recursive toggleNormals_recursive ccHObject_recursive_call0 (toggleSF, toggleSF_recursive) ccHObject_recursive_call0(toggleShowName
 
ccGenericGLDisplay setDisplay_recursive prepareDisplayForRefresh_recursive resetGLTransformationHistory_recursive toggleVisibility_recursive toggleNormals_recursive toggleShowName_recursive ccHObject_recursive_call0 (toggleMaterials, toggleMaterials_recursive) inline virtual void transferDisplay(ccGenericGLDisplay *oldDisplay
 Transfers the entity from one display to the other.
 
void applyGLTransformation_recursive (const ccGLMatrix *trans=nullptr)
 Applies the active OpenGL transformation to the entity (recursive) More...
 
virtual void notifyGeometryUpdate ()
 Notifies all dependent entities that the geometry of this entity has changed.
 
bool isSerializable () const override
 Returns whether object is serializable of not. More...
 
bool toFile (QFile &out) const override
 Saves data to binary stream. More...
 
bool fromFile (QFile &in, short dataVersion, int flags, LoadedIDMap &oldToNewIDMap) override
 Loads data from binary stream. More...
 
bool fromFileNoChildren (QFile &in, short dataVersion, int flags, LoadedIDMap &oldToNewIDMap)
 Custom version of ccSerializableObject::fromFile. More...
 
virtual bool isShareable () const
 Returns whether object is shareable or not. More...
 
virtual void setSelectionBehavior (SelectionBehavior mode)
 Sets selection behavior (when displayed) More...
 
virtual SelectionBehavior getSelectionBehavior () const
 Returns selection behavior.
 
virtual unsigned getUniqueIDForDisplay () const
 Returns object unique ID used for display. More...
 
virtual const ccGLMatrixgetGLTransformationHistory () const
 Returns the transformation 'history' matrix. More...
 
virtual void setGLTransformationHistory (const ccGLMatrix &mat)
 Sets the transformation 'history' matrix (handle with care!)
 
virtual void resetGLTransformationHistory ()
 Resets the transformation 'history' matrix.
 
bool pushDisplayState () override
 Pushes the current display state (overridden) More...
 
void popDisplayState (bool apply=true) override
 Pops the last pushed display state (overridden) More...
 
- Public Member Functions inherited from ccObject
 ccObject (const QString &name=QString(), unsigned uniqueID=ccUniqueIDGenerator::InvalidUniqueID)
 Default constructor. More...
 
 ccObject (const ccObject &object)
 Copy constructor.
 
virtual CC_CLASS_ENUM getClassID () const =0
 Returns class ID. More...
 
virtual QString getName () const
 Returns object name. More...
 
virtual void setName (const QString &name)
 Sets object name.
 
virtual unsigned getUniqueID () const
 Returns object unique ID.
 
virtual void setUniqueID (unsigned ID)
 Changes unique ID. More...
 
virtual bool isEnabled () const
 Returns whether the object is enabled or not. More...
 
virtual void setEnabled (bool state)
 Sets the "enabled" property. More...
 
virtual void toggleActivation ()
 Toggles the "enabled" property.
 
virtual bool isLocked () const
 Returns whether the object is locked or not. More...
 
virtual void setLocked (bool state)
 Sets the "enabled" property. More...
 
bool isLeaf () const
 
bool isCustom () const
 
bool isHierarchy () const
 
bool isKindOf (CC_CLASS_ENUM type) const
 
bool isA (CC_CLASS_ENUM type) const
 
QVariant getMetaData (const QString &key) const
 Returns a given associated meta data. More...
 
bool removeMetaData (const QString &key)
 Removes a given associated meta-data. More...
 
void setMetaData (const QString &key, const QVariant &data)
 Sets a meta-data element. More...
 
void setMetaData (const QVariantMap &dataset, bool overwrite=false)
 Sets several meta-data elements at a time. More...
 
bool hasMetaData (const QString &key) const
 Returns whether a meta-data element with the given key exists or not. More...
 
const QVariantMap & metaData () const
 Returns meta-data map (const only)
 
- Public Member Functions inherited from ccSerializableObject
virtual ~ccSerializableObject ()=default
 Destructor.
 
virtual bool isSerializable () const
 Returns whether object is serializable of not. More...
 
virtual bool toFile (QFile &out) const
 Saves data to binary stream. More...
 
virtual bool fromFile (QFile &in, short dataVersion, int flags, LoadedIDMap &oldToNewIDMap)
 Loads data from binary stream. More...
 
- Public Member Functions inherited from ccDrawableObject
 ccDrawableObject ()
 Default constructor.
 
 ccDrawableObject (const ccDrawableObject &object)
 Copy constructor.
 
virtual void draw (CC_DRAW_CONTEXT &context)=0
 Draws entity and its children. More...
 
virtual bool isVisible () const
 Returns whether entity is visible or not.
 
virtual void setVisible (bool state)
 Sets entity visibility.
 
virtual void toggleVisibility ()
 Toggles visibility.
 
virtual bool isVisibilityLocked () const
 Returns whether visibility is locked or not.
 
virtual void lockVisibility (bool state)
 Locks/unlocks visibility. More...
 
virtual bool isSelected () const
 Returns whether entity is selected or not.
 
virtual void setSelected (bool state)
 Selects/unselects entity.
 
virtual void getDrawingParameters (glDrawParams &params) const
 Returns main OpenGL parameters for this entity. More...
 
virtual bool hasColors () const
 Returns whether colors are enabled or not. More...
 
virtual bool colorsShown () const
 Returns whether colors are shown or not.
 
virtual void showColors (bool state)
 Sets colors visibility.
 
virtual void toggleColors ()
 Toggles colors display state.
 
virtual bool hasNormals () const
 Returns whether normals are enabled or not. More...
 
virtual bool normalsShown () const
 Returns whether normals are shown or not. More...
 
virtual void showNormals (bool state)
 Sets normals visibility. More...
 
virtual void toggleNormals ()
 Toggles normals display state.
 
virtual bool hasDisplayedScalarField () const
 Returns whether an active scalar field is available or not. More...
 
virtual bool hasScalarFields () const
 Returns whether one or more scalar fields are instantiated. More...
 
virtual void showSF (bool state)
 Sets active scalarfield visibility.
 
virtual void toggleSF ()
 Toggles SF display state.
 
virtual bool sfShown () const
 Returns whether active scalar field is visible.
 
virtual void toggleMaterials ()
 Toggles material display state. More...
 
virtual void showNameIn3D (bool state)
 Sets whether name should be displayed in 3D or not.
 
virtual bool nameShownIn3D () const
 Returns whether name is displayed in 3D or not.
 
virtual void toggleShowName ()
 Toggles name in 3D display state.
 
virtual bool isColorOverridden () const
 Returns whether colors are currently overridden by a temporary (unique) color. More...
 
virtual const ccColor::RgbagetTempColor () const
 Returns current temporary (unique) color.
 
virtual void setTempColor (const ccColor::Rgba &col, bool autoActivate=true)
 Sets current temporary (unique) More...
 
virtual void setTempColor (const ccColor::Rgb &col, bool autoActivate=true)
 Sets current temporary (unique) More...
 
virtual void enableTempColor (bool state)
 Set temporary color activation state.
 
virtual void removeFromDisplay (const ccGenericGLDisplay *win)
 Unlinks entity from a GL display (only if it belongs to it of course)
 
virtual void setDisplay (ccGenericGLDisplay *win)
 Sets associated GL display.
 
virtual ccGenericGLDisplaygetDisplay () const
 Returns associated GL display.
 
virtual void redrawDisplay ()
 Redraws associated GL display.
 
virtual void prepareDisplayForRefresh ()
 Sets associated GL display 'refreshable' before global refresh. More...
 
virtual void refreshDisplay (bool only2D=false)
 Refreshes associated GL display. More...
 
virtual void setGLTransformation (const ccGLMatrix &trans)
 Associates entity with a GL transformation (rotation + translation) More...
 
virtual void enableGLTransformation (bool state)
 Enables/disables associated GL transformation. More...
 
virtual bool isGLTransEnabled () const
 Returns whether a GL transformation is enabled or not.
 
virtual const ccGLMatrixgetGLTransformation () const
 Returns associated GL transformation. More...
 
virtual void resetGLTransformation ()
 Resets associated GL transformation. More...
 
virtual void rotateGL (const ccGLMatrix &rotMat)
 Multiplies (left) current GL transformation by a rotation matrix. More...
 
virtual void translateGL (const CCVector3 &trans)
 Translates current GL transformation by a rotation matrix. More...
 
virtual void removeAllClipPlanes ()
 Removes all clipping planes (if any)
 
virtual bool addClipPlanes (const ccClipPlane &plane)
 Registers a new clipping plane. More...
 
virtual void toggleClipPlanes (CC_DRAW_CONTEXT &context, bool enable)
 Enables or disables clipping planes (OpenGL) More...
 
virtual bool pushDisplayState ()
 Pushes the current display state. More...
 
virtual void popDisplayState (bool apply=true)
 Pops the last pushed display state. More...
 
virtual void applyDisplayState (const DisplayState &state)
 Applies a display state.
 

Protected Member Functions

bool toFile_MeOnly (QFile &out) const override
 Save own object data. More...
 
bool fromFile_MeOnly (QFile &in, short dataVersion, int flags, LoadedIDMap &oldToNewIDMap) override
 Loads own object data. More...
 
- Protected Member Functions inherited from ccShiftedObject
bool saveShiftInfoToFile (QFile &out) const
 Serialization helper (output)
 
bool loadShiftInfoFromFile (QFile &in)
 Serialization helper (input)
 
- Protected Member Functions inherited from ccHObject
virtual void setParent (ccHObject *anObject)
 Sets parent object.
 
virtual void drawMeOnly (CC_DRAW_CONTEXT &context)
 Draws the entity only (not its children) More...
 
virtual void applyGLTransformation (const ccGLMatrix &trans)
 Applies a GL transformation to the entity. More...
 
virtual bool toFile_MeOnly (QFile &out) const
 Save own object data. More...
 
virtual bool fromFile_MeOnly (QFile &in, short dataVersion, int flags, LoadedIDMap &oldToNewIDMap)
 Loads own object data. More...
 
virtual void drawNameIn3D (CC_DRAW_CONTEXT &context)
 Draws the entity name in 3D. More...
 
virtual void onDeletionOf (const ccHObject *obj)
 This method is called when another object is deleted. More...
 
virtual void onUpdateOf (ccHObject *obj)
 This method is called when another object (geometry) is updated. More...
 
- Protected Member Functions inherited from ccObject
virtual bool getFlagState (CC_OBJECT_FLAG flag) const
 Returns flag state.
 
virtual void setFlagState (CC_OBJECT_FLAG flag, bool state)
 Sets flag state. More...
 
bool toFile (QFile &out) const override
 Saves data to binary stream. More...
 
bool fromFile (QFile &in, short dataVersion, int flags, LoadedIDMap &oldToNewIDMap) override
 Reimplemented from ccSerializableObject::fromFile. More...
 

Protected Attributes

VisibilityTableType m_pointsVisibility
 Per-point visibility table. More...
 
unsigned char m_pointSize
 Point size (won't be applied if 0)
 
- Protected Attributes inherited from ccShiftedObject
CCVector3d m_globalShift
 Global shift (typically applied at loading time)
 
double m_globalScale
 Global scale (typically applied at loading time)
 
- Protected Attributes inherited from ccHObject
ccHObjectm_parent
 Parent.
 
Container m_children
 Children.
 
SelectionBehavior m_selectionBehavior
 Selection behavior.
 
std::map< ccHObject *, int > m_dependencies
 Dependencies map. More...
 
ccGLMatrix m_glTransHistory
 Cumulative GL transformation. More...
 
bool m_isDeleting
 Flag to safely handle dependencies when the object is being deleted.
 
- Protected Attributes inherited from ccObject
QString m_name
 Object name.
 
unsigned m_flags
 Object flags.
 
QVariantMap m_metaData
 Associated meta-data.
 
- Protected Attributes inherited from ccDrawableObject
bool m_visible
 Specifies whether the object is visible or not. More...
 
bool m_selected
 Specifies whether the object is selected or not.
 
bool m_lockedVisibility
 Specifies whether the visibility can be changed by user or not.
 
bool m_colorsDisplayed
 Specifies whether colors should be displayed.
 
bool m_normalsDisplayed
 Specifies whether normals should be displayed.
 
bool m_sfDisplayed
 Specifies whether scalar field should be displayed.
 
ccColor::Rgba m_tempColor
 Temporary (unique) color.
 
bool m_colorIsOverridden
 Temporary (unique) color activation state.
 
ccGLMatrix m_glTrans
 Current GL transformation. More...
 
bool m_glTransEnabled
 Current GL transformation activation state. More...
 
bool m_showNameIn3D
 Whether name is displayed in 3D or not.
 
CCVector3d m_nameIn3DPos
 Last 2D position of the '3D' name.
 
bool m_nameIn3DPosIsValid
 Whether the last 2D position of the '3D' name is valid or not.
 
ccGenericGLDisplaym_currentDisplay
 Currently associated GL display.
 
ccClipPlaneSet m_clipPlanes
 Active clipping planes (used for display only)
 
std::vector< DisplayState::Shared > m_displayStateStack
 The stack of pushed display states.
 

Friends

class ccMesh
 

Additional Inherited Members

- Static Public Member Functions inherited from ccHObject
static ccHObjectNew (CC_CLASS_ENUM objectType, const char *name=nullptr)
 Static factory. More...
 
static ccHObjectNew (const QString &pluginId, const QString &classId, const char *name=nullptr)
 Static factory (version to be used by external plugin factories) More...
 
- Static Public Member Functions inherited from ccObject
static unsigned GetCurrentDBVersion ()
 Returns current database version.
 
static void SetUniqueIDGenerator (ccUniqueIDGenerator::Shared generator)
 Sets the unique ID generator.
 
static ccUniqueIDGenerator::Shared GetUniqueIDGenerator ()
 Returns the unique ID generator.
 
static unsigned GetNextUniqueID ()
 Returns a new unassigned unique ID. More...
 
static unsigned GetLastUniqueID ()
 Returns last assigned unique ID. More...
 
static CC_CLASS_ENUM ReadClassIDFromFile (QFile &in, short dataVersion)
 Helper: reads out class ID from a binary stream. More...
 
- Static Public Member Functions inherited from ccSerializableObject
static bool WriteError ()
 Sends a custom error message (write error) and returns 'false'. More...
 
static bool ReadError ()
 Sends a custom error message (read error) and returns 'false'. More...
 
static bool MemoryError ()
 Sends a custom error message (not enough memory) and returns 'false'. More...
 
static bool CorruptError ()
 Sends a custom error message (corrupted file) and returns 'false'. More...
 
- Public Attributes inherited from ccHObject
ccGenericGLDisplay setDisplay_recursive prepareDisplayForRefresh_recursive resetGLTransformationHistory_recursive toggleVisibility_recursive toggleNormals_recursive toggleShowName_recursive ccGenericGLDisplaynewDisplay
 

Detailed Description

A 3D cloud interface with associated features (color, normals, octree, etc.)

A generic point cloud can have multiples features:

Member Typedef Documentation

◆ VisibilityTableType

using ccGenericPointCloud::VisibilityTableType = std::vector<unsigned char>

Array of "visibility" information for each point.

See <CCConst.h>

Constructor & Destructor Documentation

◆ ccGenericPointCloud()

ccGenericPointCloud::ccGenericPointCloud ( QString  name = QString(),
unsigned  uniqueID = ccUniqueIDGenerator::InvalidUniqueID 
)

Default constructor.

Parameters
namecloud name (optional)
uniqueIDunique ID (handle with care)

Member Function Documentation

◆ clear()

void ccGenericPointCloud::clear ( )
virtual

Clears the entity from all its points and features.

Display parameters are also reset to their default values.

◆ clone()

virtual ccGenericPointCloud * ccGenericPointCloud::clone ( ccGenericPointCloud destCloud = nullptr,
bool  ignoreChildren = false 
)
pure virtual

Clones this entity.

All the main features of the entity are cloned, except from the octree and the points visibility information.

Parameters
destClouddestination cloud can be provided here (must be of the exact same type as the cloned cloud!)
ignoreChildren[optional] whether to ignore the cloud's children or not (in which case they will be cloned as well)
Returns
a copy of this entity

◆ computeOctree()

ccOctree::Shared ccGenericPointCloud::computeOctree ( CCCoreLib::GenericProgressCallback *  progressCb = nullptr,
bool  autoAddChild = true 
)
virtual

Computes the cloud octree.

The octree bounding-box is automatically defined as the smallest 3D cube that totally encloses the cloud.

Warning
any previously attached octree will be deleted, even if the new octree computation failed.
Parameters
progressCbthe caller can get some notification of the process progress through this callback mechanism (see CCCoreLib documentation)
autoAddChildwhether to automatically add the computed octree as child of this cloud or not
Returns
the computed octree

◆ createNewCloudFromVisibilitySelection()

virtual ccGenericPointCloud * ccGenericPointCloud::createNewCloudFromVisibilitySelection ( bool  removeSelectedPoints = false,
VisibilityTableType visTable = nullptr,
bool  silent = false 
)
pure virtual

Creates a new point cloud with only the 'visible' points (as defined by the visibility array)

Parameters
removeSelectedPointsif true, exported point are also removed from the current point cloud
visTablevisibility table (optional, otherwise the cloud's default one will be used)
silentdon't issue a warning message if there's no point to keep
Returns
new point cloud with selected points

◆ crop()

virtual CCCoreLib::ReferenceCloud * ccGenericPointCloud::crop ( const ccBBox box,
bool  inside = true 
)
pure virtual

Crops the cloud inside (or outside) a bounding box.

Warning
Always returns a selection (potentially empty) if successful.
Parameters
boxcropping box
insidewhether selected points are inside or outside the box
Returns
points falling inside (or outside) as a selection

◆ fromFile_MeOnly()

bool ccGenericPointCloud::fromFile_MeOnly ( QFile &  in,
short  dataVersion,
int  flags,
LoadedIDMap oldToNewIDMap 
)
overrideprotectedvirtual

Loads own object data.

Called by 'fromFile' (recursive scheme) To be overloaded (but still called;) by subclass.

Parameters
ininput file
dataVersionfile version
flagsdeserialization flags (see ccSerializableObject::DeserializationFlags)
oldToNewIDMapmap to link old IDs with new IDs

Reimplemented from ccHObject.

◆ geScalarValueColor()

virtual const ccColor::Rgb * ccGenericPointCloud::geScalarValueColor ( ScalarType  d) const
pure virtual

Returns color corresponding to a given scalar value.

The returned value depends on the current scalar field display parameters. It may even be 0 if the value shouldn't be displayed.

Warning
scalar field must be enabled! (see ccDrawableObject::hasDisplayedScalarField)

◆ getOwnBB()

ccBBox ccGenericPointCloud::getOwnBB ( bool  withGLFeatures = false)
overridevirtual

Returns the entity's own bounding-box (with local/shifted coordinates)

Children bounding-boxes are ignored.

Parameters
withGLFeatureswhether to take into account display-only elements (if any)
Returns
bounding-box

Reimplemented from ccHObject.

◆ getPointColor()

virtual const ccColor::Rgba & ccGenericPointCloud::getPointColor ( unsigned  pointIndex) const
pure virtual

Returns color corresponding to a given point.

Warning
color array must be enabled! (see ccDrawableObject::hasColors)

◆ getPointDisplayedDistance()

virtual ScalarType ccGenericPointCloud::getPointDisplayedDistance ( unsigned  pointIndex) const
pure virtual

Returns scalar value associated to a given point.

The returned value is taken from the current displayed scalar field

Warning
scalar field must be enabled! (see ccDrawableObject::hasDisplayedScalarField)

◆ getPointNormal()

virtual const CCVector3 & ccGenericPointCloud::getPointNormal ( unsigned  pointIndex) const
pure virtual

Returns normal corresponding to a given point.

Warning
normals array must be enabled! (see ccDrawableObject::hasNormals)

◆ getPointNormalIndex()

virtual const CompressedNormType & ccGenericPointCloud::getPointNormalIndex ( unsigned  pointIndex) const
pure virtual

Returns compressed normal corresponding to a given point.

Warning
normals array must be enabled! (see ccDrawableObject::hasNormals)

◆ getPointScalarValueColor()

virtual const ccColor::Rgb * ccGenericPointCloud::getPointScalarValueColor ( unsigned  pointIndex) const
pure virtual

Returns color corresponding to a given point associated scalar value.

The returned value depends on the current scalar field display parameters. It may even be 0 if the value shouldn't be displayed.

Warning
scalar field must be enabled! (see ccDrawableObject::hasDisplayedScalarField)

◆ getPointSize()

unsigned char ccGenericPointCloud::getPointSize ( ) const
inline

Returns current point size.

0 means that the cloud will use current OpenGL value (see glPointSize).

◆ getTheVisiblePoints()

CCCoreLib::ReferenceCloud * ccGenericPointCloud::getTheVisiblePoints ( const VisibilityTableType visTable = nullptr,
bool  silent = false 
) const
virtual

Returns a ReferenceCloud equivalent to the visibility array.

Parameters
visTablevisibility table (optional, otherwise the cloud's default one will be used)
silentdon't issue warnings if no visible point is present
Returns
the visible points as a ReferenceCloud

◆ importParametersFrom()

void ccGenericPointCloud::importParametersFrom ( const ccGenericPointCloud cloud)

Imports the parameters from another cloud.

Only the specific parameters are imported.

◆ isSerializable()

bool ccGenericPointCloud::isSerializable ( ) const
inlineoverridevirtual

Returns whether object is serializable of not.

Reimplemented from ccSerializableObject.

◆ pointPicking()

bool ccGenericPointCloud::pointPicking ( const CCVector2d &  clickPos,
const ccGLCameraParameters camera,
int &  nearestPointIndex,
double &  nearestSquareDist,
double  pickWidth = 2.0,
double  pickHeight = 2.0,
bool  autoComputeOctree = false 
)

Point picking (brute force or octree-driven)

Warning
the octree-driven method only works if pickWidth == pickHeight

◆ resetVisibilityArray()

bool ccGenericPointCloud::resetVisibilityArray ( )
virtual

Resets the associated visibility array.

Warning: allocates the array if it was not done yet!

◆ scale()

virtual void ccGenericPointCloud::scale ( PointCoordinateType  fx,
PointCoordinateType  fy,
PointCoordinateType  fz,
CCVector3  center = CCVector3(0, 0, 0) 
)
pure virtual

Multiplies all coordinates by constant factors (one per dimension)

Warning
attached octree may be deleted.
Parameters
fxmultiplication factor along the X dimension
fymultiplication factor along the Y dimension
fzmultiplication factor along the Z dimension
centerscaling center (0,0,0) by default

◆ setPointSize()

void ccGenericPointCloud::setPointSize ( unsigned  size = 0)
inline

Sets point size.

Overrides default value one if superior than 0 (see glPointSize).

◆ toFile_MeOnly()

bool ccGenericPointCloud::toFile_MeOnly ( QFile &  out) const
overrideprotectedvirtual

Save own object data.

Called by 'toFile' (recursive scheme) To be overloaded (but still called;) by subclass.

Reimplemented from ccHObject.

Member Data Documentation

◆ m_pointsVisibility

VisibilityTableType ccGenericPointCloud::m_pointsVisibility
protected

Per-point visibility table.

If this table is allocated, only values set to POINT_VISIBLE will be considered as visible/selected.


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