CAM Library
API Reference
Selection Functions

Available Selection Functions used by CAM Library. More...

Functions

int camlib_Select_All ()
 Select all figures within the current cell. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions. More...
 
int camlib_Select_AllFilter (int nFigureType, int nLayer, int nCompositeLevel)
 Select all figures within the current cell using a filter. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions. More...
 
int camlib_Select_Rectangle (float fL, float fB, float fR, float fT)
 Select all figures contained inside the defined rectangle. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions. More...
 
int camlib_Select_RectangleFilter (float fL, float fB, float fR, float fT, int nFigureType, int nLayer, int nCompositeLevel)
 Select all figures contained inside the defined rectangle using a filter. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions. More...
 
int camlib_Select_Clear ()
 Clear all figures from the selection set. More...
 
int camlib_Select_AddMode ()
 INTERNAL USE ONLY Selected figures will be added to the Selection set. This is the default behavior. More...
 
int camlib_Select_SubtractMode ()
 INTERNAL USE ONLY Selected figures will be removed from the Selection set. If selection set is empty nothing will be done. More...
 
int camlib_Select_GetFigure (int n, int *nFigureType, int *nLayer, int *nPurpose, int *nCompositeLevel, char *net)
 Retrieves figure from the selection set and makes it active, for acess to Set and Get functions. More...
 
int camlib_Select_SetActiveFigure (int n)
 Set Figure active for acess to Set and Get functions. More...
 
int camlib_Select_GetCount ()
 Get count of figures in selection set. More...
 
int camlib_Select_RemoveFigure (int n)
 Remove figure from the selection set using an index value. More...
 

Detailed Description

Available Selection Functions used by CAM Library.

Function Documentation

◆ camlib_Select_AddMode()

int camlib_Select_AddMode ( )

INTERNAL USE ONLY Selected figures will be added to the Selection set. This is the default behavior.

Returns
Returns 0 if successful, else -1.
See also
camlib_Select_SubtractMode

◆ camlib_Select_All()

int camlib_Select_All ( )

Select all figures within the current cell. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions.

Returns
Returns 0 if successful, else -1.

◆ camlib_Select_AllFilter()

int camlib_Select_AllFilter ( int  nFigureType,
int  nLayer,
int  nCompositeLevel 
)

Select all figures within the current cell using a filter. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions.

Parameters
nFigureTypeType of Figures to Select. Assign -1 for all Types. See CAM_FigureType for values of Figure types
nLayerLayer of figures to Select. Assign -1 for all Layers.
nCompositeLevelComposite Level of figures to Select. Assign -1 for all Composite Levels.
Returns
Returns 0 if successful, else -1.

◆ camlib_Select_Clear()

int camlib_Select_Clear ( )

Clear all figures from the selection set.

Returns
Returns 0 if successful, else -1.

◆ camlib_Select_GetCount()

int camlib_Select_GetCount ( )

Get count of figures in selection set.

Returns
Count of figures in selection set.

◆ camlib_Select_GetFigure()

int camlib_Select_GetFigure ( int  n,
int *  nFigureType,
int *  nLayer,
int *  nPurpose,
int *  nCompositeLevel,
char *  net 
)

Retrieves figure from the selection set and makes it active, for acess to Set and Get functions.

Note
This is different from camlib_GetFigure() which traverses all figures in the active cell.
Parameters
nIndex of selection set.
nFigureTypeReturn figure type. See CAM_FigureType for values of Figure types
nLayerReturn figure layer.
nPurposeReturn figure purpose. Default is 0.
nCompositeLevelReturn figure composite level.
netReturn figure net name (if any).
Returns
Returns 0 if successful, else -1.

◆ camlib_Select_Rectangle()

int camlib_Select_Rectangle ( float  fL,
float  fB,
float  fR,
float  fT 
)

Select all figures contained inside the defined rectangle. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions.

Parameters
fLLeft of selection rectangle (in millimeters).
fBBottom of selection rectangle (in millimeters).
fRRight of selection rectangle (in millimeters).
fTTop of selection rectangle (in millimeters).
Returns
Returns 0 if successful, else -1.

◆ camlib_Select_RectangleFilter()

int camlib_Select_RectangleFilter ( float  fL,
float  fB,
float  fR,
float  fT,
int  nFigureType,
int  nLayer,
int  nCompositeLevel 
)

Select all figures contained inside the defined rectangle using a filter. Selected figures will be placed into an selection set which may be referenced by the CAM Library transformation functions.

Parameters
fLLeft of selection rectangle (in millimeters).
fBBottom of selection rectangle (in millimeters).
fRRight of selection rectangle (in millimeters).
fTTop of selection rectangle (in millimeters).
nFigureTypeType of Figures to Select. See CAM_FigureType for values of Figure types
nLayerLayer of figures to Select.
nCompositeLevelComposite Level of figures to Select.
Returns
Returns 0 if successful, else -1.

◆ camlib_Select_RemoveFigure()

int camlib_Select_RemoveFigure ( int  n)

Remove figure from the selection set using an index value.

Returns
Returns 0 if successful, else -1.

◆ camlib_Select_SetActiveFigure()

int camlib_Select_SetActiveFigure ( int  n)

Set Figure active for acess to Set and Get functions.

Parameters
nIndex of selection set.
Returns
Returns 0 if successful, else -1.

◆ camlib_Select_SubtractMode()

int camlib_Select_SubtractMode ( )

INTERNAL USE ONLY Selected figures will be removed from the Selection set. If selection set is empty nothing will be done.

Returns
Returns 0 if successful, else -1.
See also
camlib_Select_AddMode