|
dbSelectionSet |
  
|
|
dbSelectionSet |
|
Used to pick, store, and callback all "selected" objects.
Class Functions:
==============
void append( dbObject entity )
Add a dbObject to the end of the selection set.
void prepend( dbObject entity )
Add a dbObject to the front of the selection set.
void clear()
Remove all dbObject's stored in the selection set.
int no()
Returns the total count of dbObject's in the selection set.
int find( dbObject entity )
Return the index in the selection set for the dbObject "value". If it cannot find the dbObject, -1 is returned.
int rfind( dbObject entity )
Return the index in the selection set for the dbObject "value". If it cannot find the dbObject, -1 is returned. Begins search from back-to-front.
void insert( int pos, dbObject entity )
Insert dbObject entity into selection set at specified position
void remove( int pos )
Remove stored dbObject at specified position.
dbObject index( int pos )
Return dbObject value at specified position.
int selectionCallback()
Make all dbObjects inside this selection set as "Selected" in the editor. Returns the count of dbObjects now selected in the editor.
int selectAll()
Adds all dbObjects currently in the editor, into this selection set.
int selectSelected()
Adds all dbObjects currently "selected" in the editor, into this selection set.
int selectPoint( float x, float y )
Adds all dbObjects currently in the editor, that overlap the point (defined by x and y), into this selection set.
int selectWindow( dbPoint pt1, dbPoint pt2 )
Adds all dbObjects currently in the editor, that are contained inside the window (defined by points pt1 and pt2), into this selection set.
int selectCrossing( dbPoint pt1, dbPoint pt2 )
Adds all dbObjects currently in the editor, that intersect the window (defined by points pt1 and pt2), into this selection set.
void setLayerFilter( dbIntArray* pFilter )
Assign layer number(s) to include during selection. If the dbObject layer number is not included in the filter, it will not be added into this selection set when using selection functions: selectAll(), selectSelected(), selectPoint(), selectWindow(), selectCrossing(). The layer filter is defaulted empty, which means all layers can be selected.
void setTypeFilter( dbIntArray* pFilter )
Assign dbObject type(s) to include during selection. If the dbObject type is not included in the filter, it will not be added into this selection set when using selection functions: selectAll(), selectSelected(), selectPoint(), selectWindow(), selectCrossing(). The type filter is defaulted empty, which means all dbObject types can be selected. For a list of all available dbObject types see: dbObject Types
void setDcodeFilter( dbIntArray* pFilter )
Assign Dcodes to include during selection. If the dbObject dcode is not included in the filter, it will not be added into this selection set when using selection functions: selectAll(), selectSelected(), selectPoint(), selectWindow(), selectCrossing(). The dcode filter is defaulted empty, which means all dcodes can be selected.
void setNetFilter( dbStringArray* pFilter )
Assign net names(s) to include during selection. If the dbObject net name is not included in the filter, it will not be added into this selection set when using selection functions: selectAll(), selectSelected(), selectPoint(), selectWindow(), selectCrossing(). The net filter is defaulted empty, which means all net names can be selected.
dbIntArray* getLayerFilter()
Returns the selection set layer filter as an dbIntArray.
dbIntArray* getTypeFilter()
Returns the selection set type filter as an dbIntArray.
dbIntArray* getDcodeFilter()
Returns the selection set dcode filter as an dbIntArray.
dbStringArray* getNetFilter()
Returns the selection set net filter as an dbStringArray.