CIP JAVA documentation for class "com.ptc.wfc.wfcSelect.WSelection"

Interface WSelection

package com.ptc.wfc.wfcSelect; public interface WSelection extends com.ptc.pfc.pfcSelect.Selection

Description

Selection related methods

Method Summary
`AnnotationElement`	`AddAnnotationElement (boolean InvokeUI)` `LICENSE: 222`
`void`	`AddAnnotationReferenceInAnnotationElement (AnnotationReference Reference, boolean InvokeUI)` `LICENSE: 222`
`AnnotationElements`	`AddElementsInAnnotationFeature (Annotations Annotations, boolean InvokeUI)` `LICENSE: 222`
`void`	`CopyAnnotationElement (AnnotationElement AnnotElem)` `LICENSE: 222`
`AnnotationElement`	`CreateAnnotationFeatBaseline (Selection Reference, AnnotationPlane Plane, /optional/ Selection DirReference)` `LICENSE: 222`
`AnnotationPlane`	`CreateAnnotationPlane (Vector3D NormalVector)`
`WFeature`	`CreateFeature (ElementTree Tree, FeatCreateOptions Options, /optional/ WRegenInstructions Instrs)` Creates a feature from the Feature Element Tree
`void`	`DeleteAnnotationElement (boolean InvokeUI)` `LICENSE: 222`
`void`	`DeleteElementsInAnnotationFeature (Selections AnnotElements, boolean InvokeUI)` `LICENSE: 222`
`double`	`EvaluateAngle (WSelection Selection)` Evaluates angle between this and specified selection. Selections must represents straight edges
`double`	`EvaluateDiameter ()` Finds the geometry item (surface) diameter. Only revolved surfaces (cylinder, cone, and so on) are valid.
`/optional/ Boolean`	`GetAutoPropagateFlagInAnnotationElement (AnnotationReference Reference)` `LICENSE: 222`
`Collection`	`GetCollection ()` Get collection object containing selection
`Table`	`GetDrawingTable ()` Get drawing table object from its selection
`WFeature`	`GetPipelineFeature ()` Get pipeline feature from its selection
`/optional/ Appearance`	`GetVisibleAppearance ()` Gets the appearance properties
`/optional/ Textures`	`GetVisibleTextures ()` Gets the texture properties
`WWindow`	`GetWindow ()` Retrieves the window in which selection was made.
`void`	`RecordExternalSelection (SelectionRecordAction RecordAction)` Places external selection into `BaseSession.Select(SelectionOptions, /optional/ Selections)` buffer. Together with `WSession.RegisterExternalSelectionHighlight(ExternalSelectionHighlight)` provides interaction between external application media (like a tree) and `BaseSession.Select(SelectionOptions, /optional/ Selections)`. Upon an object selection in their media, applications should create `WSelection` and use this method to pass it to `BaseSession.Select(SelectionOptions, /optional/ Selections)`.
`void`	`RemoveAnnotationReferenceInAnnotationElement (AnnotationReference Reference, boolean InvokeUI)` `LICENSE: 222`
`void`	`SetAnnotationElementReferences (AnnotationElements Elements, AnnotationReferenceSetsArray References, boolean InvokeUI)` `LICENSE: 222` Replaces all of the each of the annotation elements' user-defined references with the indicated sets.
`void`	`SetAnnotationInAnnotationElement ( /optional/ Annotation Annotation)` `LICENSE: 222`
`void`	`SetAnnotationReferencesInAnnotationElement (AnnotationReferences References, boolean InvokeUI)` `LICENSE: 222`
`void`	`SetAutoPropagateFlagInAnnotationElement (AnnotationReference Reference, boolean AutoPropagateFlag)` `LICENSE: 222`
`void`	`SetCopyFlagInAnnotationElement (boolean CopyFlag, boolean InvokeUI)` `LICENSE: 222`
`void`	`SetDependencyFlag (boolean DependencyFlag, boolean InvokeUI)` `LICENSE: 222`
`void`	`SetVisibleAppearance ( /optional/ Appearance AppearProps)` Set the appearance properties
`void`	`SetVisibleTextures (Textures TextureProps)` Sets the texture properties
`void`	`ShowAnnotations (Drawing DrawingModel, AnnotationType AnnotType, /optional/ View2D DrawingView)`
`void`	`ShowAxes (Drawing DrawingModel, /optional/ View2D DrawingView)`
`void`	`ShowDatumTargets (Drawing DrawingModel, /optional/ View2D DrawingView)`
`void`	`StrengthenAnnotationElementReference (AnnotationReference Reference, boolean InvokeUI)` `LICENSE: 222`
`boolean`	`Verify ()` Verifies the validity of the `WSelection`.
`void`	`WeakenAnnotationElementReference (AnnotationReference Reference, boolean InvokeUI)` `LICENSE: 222`

Methods Inherited from Interface `com.ptc.pfc.pfcSelect.Selection`
`GetSelModel`, `GetSelItem`, `SetSelItem`, `GetSelTableCell`, `SetSelTableCell`, `GetSelView2D`, `SetSelView2D`, `GetSelTableSegment`, `GetPath`, `SetPath`, `GetParams`, `SetParams`, `GetTParam`, `SetTParam`, `GetPoint`, `SetPoint`, `GetDepth`, `GetSelectionString`, `Highlight`, `UnHighlight`, `Display`, `SetIntf3DCsys`

Method Detail

RecordExternalSelection

void RecordExternalSelection (SelectionRecordAction RecordAction)

Places external selection into BaseSession.Select(SelectionOptions, /*optional*/ Selections) buffer. Together with WSession.RegisterExternalSelectionHighlight(ExternalSelectionHighlight) provides interaction between external application media (like a tree) and BaseSession.Select(SelectionOptions, /*optional*/ Selections). Upon an object selection in their media, applications should create WSelection and use this method to pass it to BaseSession.Select(SelectionOptions, /*optional*/ Selections).

Exceptions thrown (but not limited to):

XToolkitInvalidItem - Rejected by ProSelect() filters.

Manual References:: External Data: Selecting the Node from the External Application Tree, External Data: Selecting the Node from the External Application Tree

Parameters:

RecordAction: Selection record action

Returns:

GetCollection

Collection GetCollection ()

Get collection object containing selection

Exceptions thrown (but not limited to):

XToolkitInvalidType - The selection object does not contain a collection.

XToolkitInvalidPtr - The selection object contains a chain, but this chain reference is no longer valid. Chain references contained in ProSelections are only valid for as long as the chain is selected in the selection buffer.

Manual References:: Selection: Adding Items to the Selection Buffer

Returns:: A collection object

GetDrawingTable

Table GetDrawingTable ()

Get drawing table object from its selection

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

Returns:: A drawing table object

GetPipelineFeature

WFeature GetPipelineFeature ()

Get pipeline feature from its selection

Manual References:: Selection: Accessing Selection Data

Returns:: A feature object

Verify

boolean Verify ()

Verifies the validity of the WSelection.

Exceptions thrown (but not limited to):

XToolkitInvalidType - Selection is invalid.

Manual References:: Selection: Interactive Selection, Selection: Interactive Selection

Returns:: Returns true if selection is valid

GetWindow

WWindow GetWindow ()

Retrieves the window in which selection was made.

Exceptions thrown (but not limited to):

XToolkitInvalidPtr - The selection argument is an invalid pointer.

Manual References:: Selection: Interactive Selection

Returns:: A WWindow object

EvaluateAngle

double EvaluateAngle (WSelection Selection)

Evaluates angle between this and specified selection. Selections must represents straight edges

Manual References:: Geometry Evaluation: Measurement, Geometry Evaluation: Measurement, ModelItem: Getting ModelItem Objects

Parameters:

Selection: Edge selection with which angle to be evaluated

Returns:: Value of the angle

EvaluateDiameter

double EvaluateDiameter ()

Finds the geometry item (surface) diameter. Only revolved surfaces (cylinder, cone, and so on) are valid.

Manual References:: Geometry Evaluation: Measurement

Returns:: The diameter

SetVisibleAppearance

void SetVisibleAppearance ( /*optional*/ Appearance AppearProps)

Set the appearance properties

Manual References:: Graphics: Surface Properties, Graphics: Surface Properties

Parameters:

AppearProps

Returns:

GetVisibleAppearance

/*optional*/ Appearance GetVisibleAppearance ()

Gets the appearance properties

Exceptions thrown (but not limited to):

XToolkitNotExist - The property does not exists.

Manual References:: Graphics: Surface Properties, Graphics: Surface Properties

Returns:

SetVisibleTextures

void SetVisibleTextures (Textures TextureProps)

Sets the texture properties

Note Call SetVisibleAppearance method before this else the method will throw an exception.

Manual References:: Graphics: Surface Properties, Graphics: Surface Properties

Parameters:

TextureProps

Returns:

GetVisibleTextures

/*optional*/ Textures GetVisibleTextures ()

Gets the texture properties

Exceptions thrown (but not limited to):

XToolkitNotExist - Properties does not exist on item.

Manual References:: Graphics: Surface Properties, Graphics: Surface Properties

Returns:

ShowAnnotations

void ShowAnnotations (Drawing DrawingModel, AnnotationType AnnotType, /*optional*/ View2D DrawingView)

Exceptions thrown (but not limited to):

XToolkitNotDisplayed - Drawing in which annotation will be shown is not displayed in the current session.

XToolkitInvalidType - Input annotation type not supported.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel
AnnotType
DrawingView

Returns:

ShowAxes

void ShowAxes (Drawing DrawingModel, /*optional*/ View2D DrawingView)

Exceptions thrown (but not limited to):

XToolkitNotDisplayed - Drawing in which annotation will be shown is not displayed in the current session.

XToolkitInvalidType - Input annotation type not supported.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel
DrawingView

Returns:

ShowDatumTargets

void ShowDatumTargets (Drawing DrawingModel, /*optional*/ View2D DrawingView)

Exceptions thrown (but not limited to):

XToolkitNotDisplayed - Drawing in which annotation will be shown is not displayed in the current session.

XToolkitInvalidType - Input annotation type not supported.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Annotations, Annotations: Annotation Features and Annotations: Accessing Annotations

Parameters:

DrawingModel
DrawingView

Returns:

CreateAnnotationPlane

AnnotationPlane CreateAnnotationPlane (Vector3D NormalVector)

Exceptions thrown (but not limited to):

XToolkitInvalidMatrix - Invalid combination of the planar surface and the direction vector.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Parameters:

NormalVector

Returns:

AddAnnotationElement

AnnotationElement AddAnnotationElement (boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitCantModify - Datum Target annotation feature cannot be modified.

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

InvokeUI

Returns:

SetAnnotationElementReferences

void SetAnnotationElementReferences (AnnotationElements Elements, AnnotationReferenceSetsArray References, boolean InvokeUI)

LICENSE: 222

Replaces all of the each of the annotation elements' user-defined references with the indicated sets.

Exceptions thrown (but not limited to):

XToolkitBadContext - The reference array contains the same reference more than once.

XToolkitUnattachedFeats - Reference modification was aborted due to regeneration failure.

XToolkitCantModify - User defined references are not permitted for driving dimension annotation elements.

XToolkitAmbiguous - The number of reference sets does not match the number of elements supplied.

XToolkitInvalidItem - One or more annotation elements do not belong to the owner feature.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Elements: Annotation elements array. All of these elements must belong to the same feature
References: Annotation reference sets array. The number of sets should match the number of elements to be modified.
InvokeUI: True to bring up the Fix Model UI in the event of regeneration failure; False to abort the reference setting.

Returns:

CopyAnnotationElement

void CopyAnnotationElement (AnnotationElement AnnotElem)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

AnnotElem

Returns:

DeleteAnnotationElement

void DeleteAnnotationElement (boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitBadContext - The annotation element is readonly and cannot be deleted.

XToolkitUnattachedFeats - Deletion was aborted due to regeneration failure.

XToolkitNotFound - The data sharing feature's parent model is not in memory;

XToolkitNotValid - The element is owned by an independent feature.

XToolkitNoPermission - Deletion of set datum tag from datum target annotation feature is not allowed.

Manual References:: Dimensions and Parameters: Accessing Reference and Driven Dimensions, Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

InvokeUI

Returns:

AddElementsInAnnotationFeature

AnnotationElements AddElementsInAnnotationFeature (Annotations Annotations, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitCantModify - Only one set datum tag can exist in Datum Target annotation feature

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

Annotations
InvokeUI

Returns:

DeleteElementsInAnnotationFeature

void DeleteElementsInAnnotationFeature (Selections AnnotElements, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitInvalidItem - Feature is invalid for this operation.

XToolkitBadContext - The annotation element is readonly and cannot be deleted.

XToolkitUnattachedFeats - Deletion was aborted due to regeneration failure.

XToolkitNotFound - The data sharing feature's parent model is not in memory;

XToolkitNotValid - The element is owned by an independent feature.

XToolkitNoPermission - Deletion of set datum tag from datum target annotation feature is not allowed.

Manual References:: Annotations: Annotation Features and Annotations: Redefining Annotation Features

Parameters:

AnnotElements
InvokeUI

Returns:

SetCopyFlagInAnnotationElement

void SetCopyFlagInAnnotationElement (boolean CopyFlag, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNoChange - The input flag is the same as the current value.

XToolkitUnattachedFeats - Reference modification was aborted due to regeneration failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

CopyFlag
InvokeUI

Returns:

SetDependencyFlag

void SetDependencyFlag (boolean DependencyFlag, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNoChange - The input flag is the same as the current value.

XToolkitCantAccess - The element is not owned by a data sharing feature.

XToolkitNotFound - The data sharing feature's parent model is not in memory.

XToolkitNotValid - The element is owned by an independent feature.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

DependencyFlag
InvokeUI

Returns:

SetAnnotationInAnnotationElement

void SetAnnotationInAnnotationElement ( /*optional*/ Annotation Annotation)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNoChange - The annotation is already contained in this element.

XToolkitUnattachedFeats - Modification was aborted due to regeneration failure.

XToolkitInvalidType - You cannot assign this type of annotation to the annotation element

XToolkitCantModify - datum target annotation element or annotation are not permitted for this function

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Annotation

Returns:

WeakenAnnotationElementReference

void WeakenAnnotationElementReference (AnnotationReference Reference, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element doesn't contain this strong reference.

XToolkitCantWrite - This strong reference may not be weakened due to the rules for the individual annotation.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

StrengthenAnnotationElementReference

void StrengthenAnnotationElementReference (AnnotationReference Reference, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element doesn't contain this weak reference.

XToolkitCantWrite - This weak reference may not be strengthened due to the rules for the individual annotation.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

SetAnnotationReferencesInAnnotationElement

void SetAnnotationReferencesInAnnotationElement (AnnotationReferences References, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitBadContext - The reference array contains the same reference more than once.

XToolkitUnattachedFeats - Reference modification was aborted due to regeneration failure.

XToolkitCantModify - User defined references are not permitted for driving dimension annotation elements.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

References
InvokeUI

Returns:

RemoveAnnotationReferenceInAnnotationElement

void RemoveAnnotationReferenceInAnnotationElement (AnnotationReference Reference, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation element does not contain this reference.

XToolkitBadContext - This reference is provided from the annotation and cannot be removed.

XToolkitUnattachedFeats - Removal was aborted due to regeneration failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

AddAnnotationReferenceInAnnotationElement

void AddAnnotationReferenceInAnnotationElement (AnnotationReference Reference, boolean InvokeUI)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitFound - The annotation element already has a reference to this item.

XToolkitCantModify - User defined references are not permitted for driving dimension annotation elements.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
InvokeUI

Returns:

SetAutoPropagateFlagInAnnotationElement

void SetAutoPropagateFlagInAnnotationElement (AnnotationReference Reference, boolean AutoPropagateFlag)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitBadContext - The element is not owned by an annotation feature.

XToolkitNotFound - The annotation element doesn't contain this reference

XToolkitNoChange - Reference autopropagate flag is already set to the input value.

XToolkitInvalidType - This type of reference does not have an autopropagate flag.

XToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference
AutoPropagateFlag

Returns:

GetAutoPropagateFlagInAnnotationElement

/*optional*/ Boolean GetAutoPropagateFlagInAnnotationElement (AnnotationReference Reference)

LICENSE: 222

Exceptions thrown (but not limited to):

XToolkitBadContext - The element is not owned by an annotation feature.

XToolkitNotFound - The annotation element doesn't contain this reference

XToolkitInvalidType - This type of reference does not have an autopropagate flag.

XToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements

Parameters:

Reference

Returns:

CreateAnnotationFeatBaseline

AnnotationElement CreateAnnotationFeatBaseline (Selection Reference, AnnotationPlane Plane, /*optional*/ Selection DirReference)

LICENSE: 222

Manual References:: Annotations: Annotation Features and Annotations: Accessing Baseline and Ordinate Dimensions

Parameters:

Reference
Plane
DirReference

Returns:

CreateFeature

WFeature CreateFeature (ElementTree Tree, FeatCreateOptions Options, /*optional*/ WRegenInstructions Instrs)

Creates a feature from the Feature Element Tree

Refer to the Release Notes for more information on restrictions of using this function with Multi-CAD models. Use pfcSelect.CreateModelSelection(Model) to get selection of part or top assembly. Use pfcSelect.CreateComponentSelection(ComponentPath) to get selection component in an assembly.

Manual References:: Feature Element Tree: Creating FET Using WCreateFeature

Parameters:

Tree: The Feature Element Tree object.
Options: Options to create the feature.
Instrs: Regeneration instructions to be used.

Returns:: The object representing the feature.