ml::PointList Class Reference

Base object class PointList managing a list of points. More...

#include <mlPointList.h>

Inheritance diagram for ml::PointList:

Public Member Functions
	PointList ()
	Constructor creating an empty list. More...
	~PointList () override
	Destructor. More...
MLssize_t	getNum () const
	returns the number of contained points More...
void	getValue (MLssize_t index, Vector3 &vec) const
	get point at given index More...
void	getValue (MLssize_t index, float &x, float &y, float &z) const
	get point at given index More...
void	addValue (const Vector3 &vec)
	add point at end of list More...
void	setValue (MLssize_t index, const Vector3 &vec)
	set value at index More...
void	removeValue (MLssize_t index=-1)
	remove point from list, if index is -1, last element is removed More...
void	clear ()
	clear all entries More...
void	print (const char *txt)
	debug print More...
Public Member Functions inherited from ml::Base
	Base ()
	Constructor. More...
virtual	~Base ()
	Destructor. More...
virtual Base *	deepCopy () const
	Creates a deep copy of the given object. More...
bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Checks whether this object's type is equal to or derived from one of the types given in the argument. More...
virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase. More...
virtual std::string	detailString () const
	Returns a string describing this object. More...
virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class. More...
virtual std::string	persistentState () const
	Returns a string describing the object's internal state. More...
virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState(). More...
virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node. More...
virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node. More...
virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Writes the objects state to the data stream object. More...
virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Reads the objects state from the data stream object. More...

Additional Inherited Members
Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Detailed Description

Base object class PointList managing a list of points.

Definition at line 29 of file mlPointList.h.

Constructor & Destructor Documentation

PointList()

ml::PointList::PointList ( )

inline

Constructor creating an empty list.

Definition at line 33 of file mlPointList.h.

~PointList()

ml::PointList::~PointList ( )

inlineoverride

Destructor.

Definition at line 36 of file mlPointList.h.

Member Function Documentation

addValue()

void ml::PointList::addValue

(

const Vector3 &

vec

)

add point at end of list

clear()

void ml::PointList::clear

(

)

clear all entries

getNum()

MLssize_t ml::PointList::getNum

(

)

const

returns the number of contained points

Referenced by ml::PCLMLTools::createPointCloudFromBaseList(), ml::ITKNodeContainerFromBasePointer(), ml::ITKPointSetFromBasePointer(), and ml::ITKPolylineFromBasePointer().

getValue() [1/2]

void ml::PointList::getValue	(	MLssize_t	index,
		float &	x,
		float &	y,
		float &	z
	)		const

get point at given index

getValue() [2/2]

void ml::PointList::getValue	(	MLssize_t	index,
		Vector3 &	vec
	)		const

get point at given index

Referenced by ml::PCLMLTools::createPointCloudFromBaseList(), ml::ITKNodeContainerFromBasePointer(), ml::ITKPointSetFromBasePointer(), and ml::ITKPolylineFromBasePointer().

print()

void ml::PointList::print

(

const char *

txt

)

debug print

removeValue()

void ml::PointList::removeValue

(

MLssize_t

index = -1

)

remove point from list, if index is -1, last element is removed

setValue()

void ml::PointList::setValue	(	MLssize_t	index,
		const Vector3 &	vec
	)

set value at index

---

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

• MeVisLab/Standard/Sources/ML/MLBase/mlPointList.h