CIP JavaScript documentation for class " pfcSelection"

Class pfcSelection

Description

This class represents a selection.

Direct Parent Classes:: pfcObject

Property Summary


`/* readonly */ number`	`Depth`
	The depth of the selection

`pfcUVParams`	`Params`
	The UV parameters

`/* optional */ pfcComponentPath`	`Path`
	The component path

`pfcPoint3D`	`Point`
	The point

`/* readonly */ string`	`SelectionString`
	Web.Link style selection string representation for this selection.

`/* optional */ pfcModelItem`	`SelItem`
	The selected model item

`/* readonly / / optional */ pfcModel`	`SelModel`
	The selected model

`/* optional */ pfcTableCell`	`SelTableCell`
	The table cell, or `null`, if the selection does not represent a drawing table cell selection.

`/* readonly / / optional */ number`	`SelTableSegment`
	The drawing table segment, or `null`, if the selection does not contain a drawing table.

`/* optional */ pfcView2D`	`SelView2D`
	The drawing view, or `null`, if the selection does not contain a drawing view.

`/* optional */ number`	`TParam`
	The T parameter of an edge or curve

Method Summary


`void`	`Display ()`
	Displays the selection. Note that this is a one-time action (the next repaint will erase this display).

`void`	`Highlight (pfcStdColor Color)`
	Highlights the selection in the current window. The selection remains highlighted until you call the Unhighlight() function.

`void`	`SetIntf3DCsys ( /* optional */ pfcSelection ReferenceCsys)`
	Set reference CSYS for export file. User should conver `pfcModel` to `pfcSelection` and then call this method on it. Use method pfcCreateModelSelection() to get `pfcSelection` from `pfcModel`

`void`	`UnHighlight ()`
	Removes the highlighting from the selection highlighted by a previous call to the Highlight() function.

Property Detail

/* readonly */ number Depth

The depth of the selection

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.

pfcUVParams Params

The UV parameters

/* optional */ pfcComponentPath Path

The component path

pfcPoint3D Point

The point

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The selection argument is an invalid pointer.

/* readonly */ string SelectionString

Web.Link style selection string representation for this selection.

/* optional */ pfcModelItem SelItem

The selected model item

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The model item doesn't exist.

/* readonly */ /* optional */ pfcModel SelModel

The selected model

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - The model item doesn't exist.

pfcXToolkitNotFound - no associated drawing found

/* optional */ pfcTableCell SelTableCell

The table cell, or null, if the selection does not represent a drawing table cell selection.

/* readonly */ /* optional */ number SelTableSegment

The drawing table segment, or null, if the selection does not contain a drawing table.

/* optional */ pfcView2D SelView2D

The drawing view, or null, if the selection does not contain a drawing view.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - no associated drawing found

/* optional */ number TParam

The T parameter of an edge or curve

Method Detail

void Display ()

Displays the selection. Note that this is a one-time action (the next repaint will erase this display).

void Highlight (pfcStdColor Color)

Highlights the selection in the current window. The selection remains highlighted until you call the Unhighlight() function.

Parameters:

Color: The highlight color

void SetIntf3DCsys ( /* optional */ pfcSelection ReferenceCsys)

Set reference CSYS for export file. User should conver pfcModel to pfcSelection and then call this method on it. Use method pfcCreateModelSelection() to get pfcSelection from pfcModel

Parameters:

ReferenceCsys: The reference coordinate system selection. This is Optional argument. Call this method without any argument to set default coordinate system. Reference CSYS is not supported for CADDS and NEUTRAL file types.

void UnHighlight ()

Removes the highlighting from the selection highlighted by a previous call to the Highlight() function.