CIP Visual Basic.NET documentation for interface "IpfcSelection"

Interface IpfcSelection

Description

This class represents a selection.

Direct Parent Classes:: IpfcObject

Property Summary


`Property`	`Depth`	`as Double`
	The depth of the selection

`Property`	`Params`	`as IpfcUVParams`
	The UV parameters

`Property`	`Path`	`as IpfcComponentPath [optional]`
	The component path

`Property`	`Point`	`as IpfcPoint3D`
	The point

`Property`	`SelItem`	`as IpfcModelItem [optional]`
	The selected model item

`Property`	`SelModel`	`as IpfcModel [readonly, optional]`
	The selected model

`Property`	`SelTableCell`	`as IpfcTableCell [optional]`
	The table cell, or `null`, if the selection does not represent a drawing table cell selection.

`Property`	`SelTableSegment`	`as Long [readonly, optional]`
	The drawing table segment, or `null`, if the selection does not contain a drawing table.

`Property`	`SelView2D`	`as IpfcView2D [optional]`
	The drawing view, or `null`, if the selection does not contain a drawing view.

`Property`	`TParam`	`as Double [optional]`
	The T parameter of an edge or curve

Method Summary


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

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

`Sub`	`SetIntf3DCsys (ReferenceCsys as IpfcSelection [optional])`
	Set reference CSYS for export file. User should conver `IpfcModel` to `IpfcSelection` and then call this method on it. Use method pfcCreateModelSelection() to get `IpfcSelection` from `IpfcModel`

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

Property Detail

Property Depth as Double

The depth of the selection

Exceptions thrown (but not limited to):

IpfcXToolkitInvalidPtr - The selection argument is an invalid pointer.

Property Params as IpfcUVParams

The UV parameters

Property Path as IpfcComponentPath [optional]

The component path

Property Point as IpfcPoint3D

The point

Exceptions thrown (but not limited to):

IpfcXToolkitInvalidPtr - The selection argument is an invalid pointer.

Property SelItem as IpfcModelItem [optional]

The selected model item

Exceptions thrown (but not limited to):

IpfcXToolkitNotExist - The model item doesn't exist.

Property SelModel as IpfcModel [readonly, optional]

The selected model

Exceptions thrown (but not limited to):

IpfcXToolkitNotExist - The model item doesn't exist.

IpfcXToolkitNotFound - no associated drawing found

Property SelTableCell as IpfcTableCell [optional]

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

Property SelTableSegment as Long [readonly, optional]

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

Property SelView2D as IpfcView2D [optional]

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - no associated drawing found

Property TParam as Double [optional]

The T parameter of an edge or curve

Method Detail

Sub Display ()

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

Sub Highlight (Color as IpfcStdColor)

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

Parameters:

Color: The highlight color

Sub SetIntf3DCsys (ReferenceCsys as IpfcSelection [optional])

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

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.

Sub UnHighlight ()

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