CIP JAVA documentation for class "com.ptc.pfc.pfcSelect.Selection"

Interface Selection

package com.ptc.pfc.pfcSelect; public interface Selection extends com.ptc.pfc.pfcObject.Object

Description

This class represents a selection.

Direct Known Subclasses:: WSelection

Method Summary
`void`	`Display ()` Displays the selection. Note that this is a one-time action (the next repaint will erase this display).
`double`	`GetDepth ()` Get method for attribute "Depth" The depth of the selection
`UVParams`	`GetParams ()` Get method for attribute "Params" The UV parameters
`/optional/ ComponentPath`	`GetPath ()` Get method for attribute "Path" The component path
`Point3D`	`GetPoint ()` Get method for attribute "Point" The point
`String`	`GetSelectionString ()` Get method for attribute "SelectionString" Web.Link style selection string representation for this selection.
`/optional/ ModelItem`	`GetSelItem ()` Get method for attribute "SelItem" The selected model item
`/optional/ Model`	`GetSelModel ()` Get method for attribute "SelModel" The selected model
`/optional/ TableCell`	`GetSelTableCell ()` Get method for attribute "SelTableCell" The table cell, or `null`, if the selection does not represent a drawing table cell selection.
`/optional/ Integer`	`GetSelTableSegment ()` Get method for attribute "SelTableSegment" The drawing table segment, or `null`, if the selection does not contain a drawing table.
`/optional/ View2D`	`GetSelView2D ()` Get method for attribute "SelView2D" The drawing view, or `null`, if the selection does not contain a drawing view.
`/optional/ Double`	`GetTParam ()` Get method for attribute "TParam" The T parameter of an edge or curve
`void`	`Highlight (StdColor Color)` Highlights the selection in the current window. The selection remains highlighted until you call the Unhighlight() function.
`void`	`SetIntf3DCsys ( /optional/ Selection ReferenceCsys)` Set reference CSYS for export file. User should conver `Model` to `Selection` and then call this method on it. Use method pfcCreateModelSelection() to get `Selection` from `Model`
`void`	`SetParams (UVParams value)` Set method for attribute "Params" The UV parameters
`void`	`SetPath ( /optional/ ComponentPath value)` Set method for attribute "Path" The component path
`void`	`SetPoint (Point3D value)` Set method for attribute "Point" The point
`void`	`SetSelItem ( /optional/ ModelItem value)` Set method for attribute "SelItem" The selected model item
`void`	`SetSelTableCell ( /optional/ TableCell value)` Set method for attribute "SelTableCell" The table cell, or `null`, if the selection does not represent a drawing table cell selection.
`void`	`SetSelView2D ( /optional/ View2D value)` Set method for attribute "SelView2D" The drawing view, or `null`, if the selection does not contain a drawing view.
`void`	`SetTParam ( /optional/ Double value)` Set method for attribute "TParam" The T parameter of an edge or curve
`void`	`UnHighlight ()` Removes the highlighting from the selection highlighted by a previous call to the Highlight() function.

Method Detail

GetSelModel

/*optional*/ Model GetSelModel ()

The selected model

Exceptions thrown (but not limited to):

XToolkitNotExist - The model item doesn't exist.

XToolkitNotFound - no associated drawing found

Manual References:: Models: Getting a Model Object, Models: Getting a Model Object, Selection: Accessing Selection Data, Selection: Accessing Selection Data

GetSelItem/SetSelItem

`/optional/ ModelItem`	`GetSelItem`	`()`
`void`	`SetSelItem`	`( /optional/ ModelItem value)`

The selected model item

Exceptions thrown (but not limited to):

XToolkitNotExist - The model item doesn't exist.

Manual References:: ModelItem: Getting ModelItem Objects, ModelItem: Getting ModelItem Objects, Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Obtaining Drawing Dimensions, Drawings: Selecting Drawing Tables and Cells, Drawings: Selecting Drawing Tables and Cells, Selection: Programmatic Selection, Selection: Programmatic Selection

GetSelTableCell/SetSelTableCell

`/optional/ TableCell`	`GetSelTableCell`	`()`
`void`	`SetSelTableCell`	`( /optional/ TableCell value)`

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

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Selecting Drawing Tables and Cells, Drawings: Selecting Drawing Tables and Cells, Selection: Programmatic Selection, Selection: Programmatic Selection

GetSelView2D/SetSelView2D

`/optional/ View2D`	`GetSelView2D`	`()`
`void`	`SetSelView2D`	`( /optional/ View2D value)`

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

Exceptions thrown (but not limited to):

XToolkitNotFound - no associated drawing found

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Obtaining Drawing Views, Drawings: Obtaining Drawing Views, Selection: Programmatic Selection

GetSelTableSegment

/*optional*/ Integer GetSelTableSegment ()

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

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Drawings: Selecting Drawing Tables and Cells, Drawings: Drawing Table Segments, Drawings: Drawing Table Segments

GetPath/SetPath

`/optional/ ComponentPath`	`GetPath`	`()`
`void`	`SetPath`	`( /optional/ ComponentPath value)`

The component path

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Selection: Programmatic Selection, Selection: Programmatic Selection

GetParams/SetParams

`UVParams`	`GetParams`	`()`
`void`	`SetParams`	`(UVParams value)`

The UV parameters

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Selection: Programmatic Selection, Selection: Programmatic Selection

GetTParam/SetTParam

`/optional/ Double`	`GetTParam`	`()`
`void`	`SetTParam`	`( /optional/ Double value)`

The T parameter of an edge or curve

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Selection: Programmatic Selection, Selection: Programmatic Selection

GetPoint/SetPoint

`Point3D`	`GetPoint`	`()`
`void`	`SetPoint`	`(Point3D value)`

The point

Exceptions thrown (but not limited to):

XToolkitInvalidPtr - The selection argument is an invalid pointer.

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data, Assembly: Kinematic Dragging and Creating Snapshots: Performing Kinematic Drag, Selection: Programmatic Selection, Selection: Programmatic Selection

GetDepth

double GetDepth ()

The depth of the selection

Exceptions thrown (but not limited to):

XToolkitInvalidPtr - The selection argument is an invalid pointer.

Manual References:: Selection: Accessing Selection Data, Selection: Accessing Selection Data

GetSelectionString

String GetSelectionString ()

Web.Link style selection string representation for this selection.

Highlight

void Highlight (StdColor Color)

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

Manual References:: Selection: Controlling Selection Display, Selection: Controlling Selection Display

Parameters:

Color: The highlight color

Returns:

UnHighlight

void UnHighlight ()

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

Manual References:: Selection: Controlling Selection Display, Selection: Controlling Selection Display

Returns:

Display

void Display ()

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

Manual References:: Selection: Controlling Selection Display

Returns:

SetIntf3DCsys

void SetIntf3DCsys ( /*optional*/ Selection ReferenceCsys)

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

Manual References:: Interface: Exporting Using Coordinate System

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.

Returns: