Base object representing a list of vectors given as Vector4's. More...

#include <mlVectorList.h>

Inheritance diagram for ml::VectorList:

Public Member Functions
	VectorList ()

	~VectorList () override

MLssize_t	getNum () const
	returns the number of contained points

void	getValue (MLssize_t index, int &type, Vector3 &p1, Vector3 &p2) const
	get point at given index

void	getValue (MLssize_t index, int &type, float &x1, float &y1, float &z1, float &x2, float &y2, float &z2) const
	get point at given index

void	addValue (int type, const Vector3 &p1, const Vector3 &p2)
	add point at end of list

void	setValue (MLssize_t index, int type, const Vector3 &p1, const Vector3 &p2)
	set value at index

void	removeValue (MLssize_t index=-1)
	remove point from list, if index is -1, last element is removed

void	getPoint (MLssize_t index, int &type, float &x1, float &y1, float &z1) const
	returns point of vectors at given point index (NOTE: (0,1 = first vector , 2,3 = second vector))

void	setPoint (MLssize_t index, int type, float x, float y, float z)
	set point of vectors at given point index (NOTE: (0,1 = first vector , 2,3 = second vector))

void	clear ()
	clear all entries

void	print (const char *txt)
	debug print

Public Member Functions inherited from ml::Base
	Base ()
	Constructor.

virtual	~Base ()
	Destructor.

virtual Base *	deepCopy () const
	Creates a deep copy of the given object.

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.

virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.

virtual std::string	detailString () const
	Returns a string describing this object.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState().

virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node.

virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node.

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Writes the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Reads the objects state from the data stream object.

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 representing a list of vectors given as Vector4's.

Definition at line 29 of file mlVectorList.h.

Constructor & Destructor Documentation

◆ VectorList()

ml::VectorList::VectorList ( )

inline

Definition at line 32 of file mlVectorList.h.

◆ ~VectorList()

ml::VectorList::~VectorList ( )

inlineoverride

Definition at line 33 of file mlVectorList.h.

Member Function Documentation

◆ addValue()

void ml::VectorList::addValue	(	int	type,
		const Vector3 &	p1,
		const Vector3 &	p2 )

add point at end of list

◆ clear()

void ml::VectorList::clear ( )

clear all entries

◆ getNum()

MLssize_t ml::VectorList::getNum ( ) const

returns the number of contained points

◆ getPoint()

void ml::VectorList::getPoint	(	MLssize_t	index,
		int &	type,
		float &	x1,
		float &	y1,
		float &	z1 ) const

returns point of vectors at given point index (NOTE: (0,1 = first vector , 2,3 = second vector))

◆ getValue() [1/2]

void ml::VectorList::getValue	(	MLssize_t	index,
		int &	type,
		float &	x1,
		float &	y1,
		float &	z1,
		float &	x2,
		float &	y2,
		float &	z2 ) const

get point at given index

◆ getValue() [2/2]

void ml::VectorList::getValue	(	MLssize_t	index,
		int &	type,
		Vector3 &	p1,
		Vector3 &	p2 ) const

get point at given index

◆ print()

void ml::VectorList::print ( const char * txt )

debug print

◆ removeValue()

void ml::VectorList::removeValue ( MLssize_t index = -1 )

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

◆ setPoint()

void ml::VectorList::setPoint	(	MLssize_t	index,
		int	type,
		float	x,
		float	y,
		float	z )

set point of vectors at given point index (NOTE: (0,1 = first vector , 2,3 = second vector))

◆ setValue()

void ml::VectorList::setValue	(	MLssize_t	index,
		int	type,
		const Vector3 &	p1,
		const Vector3 &	p2 )

set value at index

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

MeVisLab/Standard/Sources/ML/MLBase/mlVectorList.h

Public Member Functions

Additional Inherited Members