qCC_db  version 2.5.4 (Qt) - 19 Apr 2014
 All Classes Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ccPolyline Class Reference

Colored polyline. More...

#include <ccPolyline.h>

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

Public Member Functions

 ccPolyline (GenericIndexedCloudPersist *associatedCloud)
 Default constructor. More...
 
 ccPolyline (const ccPolyline &poly)
 Copy constructor. More...
 
virtual ~ccPolyline ()
 Destructor.
 
virtual CC_CLASS_ENUM getClassID () const
 Returns class ID.
 
virtual bool isSerializable () const
 Returns whether object is serializable of not.
 
virtual bool hasColors () const
 Returns whether colors are enabled or not.
 
virtual void applyGLTransformation (const ccGLMatrix &trans)
 Applies a GL transformation to the entity. More...
 
virtual unsigned getUniqueIDForDisplay () const
 Returns object unqiue ID used for display.
 
void set2DMode (bool state)
 Defines if the polyline is considered as 2D or 3D. More...
 
bool is2DMode () const
 Returns whether the polyline is considered as 2D or 3D.
 
void setForeground (bool state)
 Defines if the polyline is drawn in background or foreground. More...
 
void setColor (const colorType col[])
 Sets the polyline color. More...
 
void setWidth (PointCoordinateType width)
 Sets the width of the line. More...
 
PointCoordinateType getWidth () const
 Returns the width of the line. More...
 
const colorType * getColor () const
 Returns the polyline color. More...
 
virtual ccBBox getMyOwnBB ()
 Returns the entity bounding-box only. More...
 
bool split (PointCoordinateType maxEdgelLength, std::vector< ccPolyline * > &parts)
 Splits the polyline into several parts based on a maximum edge length. More...
 
PointCoordinateType computeLength () const
 Computes the polyline length.
 
void showVertices (bool state)
 Sets whether to display or hide the polyline vertices.
 
bool verticesShown () const
 Whether the polyline vertices should be displayed or not.
 
void setVertexMarkerWidth (int width)
 Sets the width of vertex markers.
 
int getVertexMarkerWidth () const
 Returns the width of vertex markers.
 
- Public Member Functions inherited from ccHObject
 ccHObject (QString name=QString())
 Default constructor. More...
 
virtual ~ccHObject ()
 Default destructor.
 
virtual QIcon getIcon () const
 Returns the icon associated to this entity. More...
 
ccHObjectgetParent () const
 Returns parent object. More...
 
void addDependency (ccHObject *otherObject, int flags, bool additive=true)
 Adds a new dependence (additive or not) More...
 
int getDependencyFlagsWith (const ccHObject *otherObject)
 Returns the dependency flags with a given object. More...
 
void removeDependencyWith (const 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...
 
ccHObjectgetChild (unsigned childPos) const
 Returns the ith child. More...
 
ccHObjectfind (int uniqueID)
 Finds an entity in this object hierarchy. More...
 
unsigned filterChildren (Container &filteredChildren, bool recursive=false, CC_CLASS_ENUM filter=CC_TYPES::OBJECT) const
 Collects the children corresponding to a certain pattern. More...
 
void detachChild (ccHObject *child)
 Detaches a specific child. More...
 
void detatchAllChildren ()
 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 getBB (bool relative=true, bool withGLfeatures=false, const ccGenericGLDisplay *window=NULL)
 Returns bounding-box. More...
 
virtual void draw (CC_DRAW_CONTEXT &context)
 Draws entity and its children.
 
virtual bool isDisplayed () const
 Returns whether the object is actually displayed (visible) 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, prepareDisplayForRefresh_recursive)
 
 ccHObject_recursive_call0 (refreshDisplay, refreshDisplay_recursive)
 
 ccHObject_recursive_call0 (toggleVisibility, toggleVisibility_recursive)
 
 ccHObject_recursive_call0 (toggleColors, toggleColors_recursive)
 
 ccHObject_recursive_call0 (toggleNormals, toggleNormals_recursive)
 
 ccHObject_recursive_call0 (toggleSF, toggleSF_recursive)
 
 ccHObject_recursive_call0 (toggleShowName, toggleShowName_recursive)
 
 ccHObject_recursive_call0 (toggleMaterials, toggleMaterials_recursive)
 
void applyGLTransformation_recursive (ccGLMatrix *trans=0)
 Applies the active OpenGL transformation to the entity (recursive) More...
 
virtual CCVector3 getBBCenter ()
 Returns the bounding-box center. More...
 
void notifyGeometryUpdate ()
 Notifies all dependent entities that the geometry of this entity has changed.
 
virtual ccBBox getDisplayBB ()
 Returns the entity GL display bounding-box. More...
 
virtual bool toFile (QFile &out) const
 Saves data to binay stream. More...
 
virtual bool fromFile (QFile &in, short dataVersion, int flags)
 Reimplemented from ccSerializableObject::fromFile. More...
 
virtual bool isShareable () const
 Returns whether object is shareable or not. More...
 
void setSelectionBehavior (SelectionBehavior mode)
 Sets selection behavior (when displayed) More...
 
SelectionBehavior getSelectionBehavior () const
 Returns selection behavior.
 
- Public Member Functions inherited from ccObject
 ccObject (QString name=QString())
 Default constructor. More...
 
virtual QString getName () const
 Returns object name.
 
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 bool isLocked () const
 Returns whether the object is locked or not. More...
 
virtual void setLocked (bool state)
 Sets the "enabled" property. More...
 
bool isGroup () const
 
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 (QString key) const
 Returns a given associated meta data. More...
 
bool removeMetaData (QString key)
 Removes a given associated meta data. More...
 
void setMetaData (QString key, QVariant data)
 Sets a meta data element. More...
 
bool hasMetaData (QString key)
 Says if a metadata 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 ()
 Desctructor.
 
- Public Member Functions inherited from ccDrawableObject
 ccDrawableObject ()
 Default constructor.
 
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 isVisiblityLocked () const
 Returns whether visibilty is locked or not.
 
virtual void lockVisibility (bool state)
 Locks/unlocks visibilty. More...
 
virtual bool isSelected () const
 Returns whether entity is selected or not.
 
virtual void setSelected (bool state)
 Selects/unselects entity.
 
virtual ccBBox getFitBB (ccGLMatrix &trans)
 Returns best-fit bounding-box (if available) More...
 
virtual void drawBB (const colorType col[])
 Draws absolute (axis aligned) bounding-box.
 
virtual void getDrawingParameters (glDrawParams &params) const
 Returns main OpenGL paramters for this entity. 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.
 
virtual bool normalsShown () const
 Returns whether normals are shown or not.
 
virtual void showNormals (bool state)
 Sets normals visibility.
 
virtual void toggleNormals ()
 Toggles normals display state.
 
virtual bool hasDisplayedScalarField () const
 Returns whether an active scalar field is available or not.
 
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.
 
virtual void showNameIn3D (bool state)
 Sets whether name should be displayed in 3D.
 
virtual bool nameShownIn3D () const
 Returns whether name is displayed in 3D or not.
 
virtual void toggleShowName ()
 Toggles name in 3D display state.
 
virtual bool isColorOverriden () const
 Returns whether colors are currently overriden by a temporary (unique) color. More...
 
virtual const colorType * getTempColor () const
 Returns current temporary (unique) color.
 
virtual void setTempColor (const colorType *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 ()
 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
 Retuns associated GL transformation. More...
 
virtual void resetGLTransformation ()
 Resets associated GL transformation. More...
 
virtual void rotateGL (const ccGLMatrix &rotMat)
 Mutliplies (left) current GL transformation by a rotation matrix. More...
 
virtual void translateGL (const CCVector3 &trans)
 Translates current GL transformation by a rotation matrix. More...
 

Static Public Member Functions

static ccPolylineExtractFlatContour (CCLib::GenericIndexedCloudPersist *points, PointCoordinateType maxEdgelLength=0, const PointCoordinateType *preferredDim=0)
 Extracts a unique closed (2D) contour polyline of a point cloud. More...
 
static bool ExtractFlatContour (CCLib::GenericIndexedCloudPersist *points, PointCoordinateType maxEdgelLength, std::vector< ccPolyline * > &parts, bool allowSplitting=true, const PointCoordinateType *preferredDim=0)
 Extracts one or several parts of the (2D) contour polyline of a point cloud. More...
 
- Static Public Member Functions inherited from ccHObject
static ccHObjectNew (CC_CLASS_ENUM objectType, const char *name=0)
 Static factory. More...
 
- Static Public Member Functions inherited from ccObject
static unsigned GetCurrentDBVersion ()
 Returns current database version.
 
static void ResetUniqueIDCounter ()
 Resets the object's unique ID counter. More...
 
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...
 

Protected Member Functions

virtual bool toFile_MeOnly (QFile &out) const
 Save own object data. More...
 
virtual bool fromFile_MeOnly (QFile &in, short dataVersion, int flags)
 Loads own object data. More...
 
virtual void drawMeOnly (CC_DRAW_CONTEXT &context)
 Draws the entity only (not its children)
 
void initWith (ccPointCloud *vertices, const ccPolyline &poly)
 Initializes the polyline with a given set of vertices and the parameters of another polyline. More...
 
- Protected Member Functions inherited from ccHObject
virtual void setParent (ccHObject *anObject)
 Sets parent object.
 
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...
 

Protected Attributes

colorType m_rgbColor [3]
 Unique RGB color.
 
PointCoordinateType m_width
 Width of the line.
 
bool m_mode2D
 Whether poyline should be considered as 2D (true) or 3D (false)
 
bool m_foreground
 Whether poyline should draws itself in background (false) or foreground (true)
 
bool m_showVertices
 Whether vertices should be displayed or not.
 
int m_vertMarkWidth
 Vertex marker width.
 
- Protected Attributes inherited from ccHObject
ccHObjectm_parent
 Object's parent.
 
Container m_children
 Object's children.
 
SelectionBehavior m_selectionBehavior
 Selection behavior.
 
std::map< ccHObject *, int > m_dependencies
 Dependencies map. More...
 
- 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.
 
colorType m_tempColor [3]
 Temporary (unique) color.
 
bool m_colorIsOverriden
 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.
 
ccGenericGLDisplaym_currentDisplay
 Currently associated GL display.
 

Additional Inherited Members

- 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.
 
typedef std::vector< ccHObject * > Container
 standard ccHObject container (for children, etc.)
 
- Public Types inherited from ccSerializableObject
enum  DeserializationFlags { DF_POINT_COORDS_64_BITS = 1, DF_SCALAR_VAL_32_BITS = 2 }
 Deserialization flags (bit-field) More...
 
- Static Protected Member Functions inherited from ccObject
static void UpdateLastUniqueID (unsigned lastID)
 Sets last assigned unique ID. More...
 

Detailed Description

Colored polyline.

Extends the Polyline class of CCLib. Check CCLib documentation for more information about it.

Constructor & Destructor Documentation

ccPolyline::ccPolyline ( GenericIndexedCloudPersist *  associatedCloud)

Default constructor.

Parameters
associatedCloudthe associated point cloud (e.g. the summits)
ccPolyline::ccPolyline ( const ccPolyline poly)

Copy constructor.

Parameters
polypolyline to clone

Member Function Documentation

void ccPolyline::applyGLTransformation ( const ccGLMatrix trans)
virtual

Applies a GL transformation to the entity.

this = rotMat*(this-rotCenter)+(rotCenter+trans)

Parameters
transa ccGLMatrix structure

Reimplemented from ccHObject.

ccPolyline * ccPolyline::ExtractFlatContour ( CCLib::GenericIndexedCloudPersist *  points,
PointCoordinateType  maxEdgelLength = 0,
const PointCoordinateType *  preferredDim = 0 
)
static

Extracts a unique closed (2D) contour polyline of a point cloud.

Projects the cloud on its best fitting LS plane first.

Parameters
pointspoint cloud
maxEdgelLengthmax edge length (ignored if 0, in which case the contour is the convex hull)
preferredDimto specifiy a preferred (normal) direction for the polyline extraction
Returns
contour polyline (or 0 if an error occurred)
bool ccPolyline::ExtractFlatContour ( CCLib::GenericIndexedCloudPersist *  points,
PointCoordinateType  maxEdgelLength,
std::vector< ccPolyline * > &  parts,
bool  allowSplitting = true,
const PointCoordinateType *  preferredDim = 0 
)
static

Extracts one or several parts of the (2D) contour polyline of a point cloud.

Projects the cloud on its best fitting LS plane first.

Warning
output polylines set (parts) may be empty if all the vertices are too far from each other!
Parameters
pointspoint cloud
maxEdgelLengthmax edge length (ignored if 0, in which case the contour is the convex hull)
[out]partsoutput polyline parts
allowSplittingwhether the polyline can be split or not
preferredDimto specifiy a preferred (normal) direction for the polyline extraction
Returns
success
bool ccPolyline::fromFile_MeOnly ( QFile &  in,
short  dataVersion,
int  flags 
)
protectedvirtual

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)

Reimplemented from ccHObject.

const colorType * ccPolyline::getColor ( ) const

Returns the polyline color.

Returns
a pointer to the polyline RGB color
ccBBox ccPolyline::getMyOwnBB ( )
virtual

Returns the entity bounding-box only.

Children bboxes are ignored.

Returns
bounding-box

Reimplemented from ccHObject.

PointCoordinateType ccPolyline::getWidth ( ) const
inline

Returns the width of the line.

Returns
the width of the line in pixels
void ccPolyline::initWith ( ccPointCloud vertices,
const ccPolyline poly 
)
protected

Initializes the polyline with a given set of vertices and the parameters of another polyline.

Warning
Even the 'closed' state is copied as is!
void ccPolyline::set2DMode ( bool  state)

Defines if the polyline is considered as 2D or 3D.

Parameters
stateif true, the polyline is 2D
void ccPolyline::setColor ( const colorType  col[])

Sets the polyline color.

Parameters
colRGB color
void ccPolyline::setForeground ( bool  state)

Defines if the polyline is drawn in background or foreground.

Parameters
stateif true, the polyline is drawn in foreground
void ccPolyline::setWidth ( PointCoordinateType  width)

Sets the width of the line.

Parameters
widththe desired width
bool ccPolyline::split ( PointCoordinateType  maxEdgelLength,
std::vector< ccPolyline * > &  parts 
)

Splits the polyline into several parts based on a maximum edge length.

Warning
output polylines set (parts) may be empty if all the vertices are too far from each other!
Parameters
maxEdgelLengthmaximum edge length
[out]partsoutput polyline parts
Returns
success
bool ccPolyline::toFile_MeOnly ( QFile &  out) const
protectedvirtual

Save own object data.

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

Reimplemented from ccHObject.


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