PathSelectionList Class Reference

#include <PathSelectionList.h>

Public Member Functions
	PathSelectionList (IDataBase *db=nil)
ErrorCode	SetDataBase (IDataBase *db)
IDataBase *	GetDataBase () const
ErrorCode	Add (const UIDRef &item, const PointSelector &handle)
ErrorCode	Add (const UIDRef &item, const PointSelectorList &pts)
ErrorCode	Add (const PathSelectionList &list)
ErrorCode	Clear ()
ErrorCode	Clear (const UIDRef &item)
ErrorCode	Clear (const UIDRef &item, const PointSelector &handle)
ErrorCode	Clear (const UIDRef &item, const PointSelectorList &pts)
ErrorCode	Clear (const PathSelectionList &list)
bool16	IsEmpty () const
bool16	IsSelected (const UIDRef &item) const
bool16	IsSelected (const UIDRef &item, const PointSelector &handle) const
int32	Length () const
UIDList	GetItemList () const
int32	Length (const UIDRef &item) const
void	GetComponentList (const UIDRef &item, PointSelectorList &ptsOut) const
void	ReadWrite (IPMStream *s, IDataBase *db)
bool16	operator== (const PathSelectionList &other) const
bool16	operator!= (const PathSelectionList &other) const

Detailed Description

A path point selection may contain anchor points and/or path segments (collectively known as path components). An anchor point is indicated by PointSelector::Selector() == kAnchorPt. A path segment is indicated by PointSelector::Selector() == kSegment.

Constructor & Destructor Documentation

PathSelectionList::PathSelectionList

(

IDataBase *

db = nil

)

Constructs empty list

Member Function Documentation

ErrorCode PathSelectionList::Add	(	const UIDRef &	item,
		const PointSelector &	handle
	)

Adds path component to selection

ErrorCode PathSelectionList::Add	(	const UIDRef &	item,
		const PointSelectorList &	pts
	)

Adds path components to selection

ErrorCode PathSelectionList::Add

(

const PathSelectionList &

list

)

Appends another path selection list onto this one

ErrorCode PathSelectionList::Clear

(

)

Clears all path components

ErrorCode PathSelectionList::Clear

(

const UIDRef &

item

)

Clears all path components for this item

ErrorCode PathSelectionList::Clear	(	const UIDRef &	item,
		const PointSelector &	handle
	)

Clears this path component for this item

ErrorCode PathSelectionList::Clear	(	const UIDRef &	item,
		const PointSelectorList &	pts
	)

Clears these path components for this item

ErrorCode PathSelectionList::Clear

(

const PathSelectionList &

list

)

Clears these path components

void PathSelectionList::GetComponentList	(	const UIDRef &	item,
		PointSelectorList &	ptsOut
	)		const

Return list of path components selected on object

IDataBase* PathSelectionList::GetDataBase ( void  ) const

inline

Get the database

UIDList PathSelectionList::GetItemList

(

)

const

Return list of objects with path components selected

bool16 PathSelectionList::IsEmpty

(

)

const

Returns kTrue if there are no path components selected

bool16 PathSelectionList::IsSelected

(

const UIDRef &

item

)

const

Returns kTrue if one or more path components on this item are selected

bool16 PathSelectionList::IsSelected	(	const UIDRef &	item,
		const PointSelector &	handle
	)		const

Returns kTrue if this path component on this item is selected

int32 PathSelectionList::Length

(

)

const

Return number of objects with path components selected

int32 PathSelectionList::Length

(

const UIDRef &

item

)

const

Return number of path components selected on object

ErrorCode PathSelectionList::SetDataBase

(

IDataBase *

db

)

Set the database