CIP JAVA documentation for class "com.ptc.wfc.wfcAnnotation.AnnotationPlane"

Interface AnnotationPlane

package com.ptc.wfc.wfcAnnotation; public interface AnnotationPlane extends com.ptc.wfc.wfcModelItem.WModelItem

Description

Method Summary
`void`	`AssignName (String AnnotationPlaneName)` Assigns name to annotation plane.
`boolean`	`GetFlip ()` `LICENSE: 222` Get the 'Flip' property of an annotation plane.
`/optional/ stringseq`	`GetNames ()` Get the names corresponding to the annotation plane.
`Vector3D`	`GetNormalVector ()`
`double`	`GetPlaneAngle ()` `LICENSE: 222`
`WPlaneData`	`GetPlaneData ()`
`Vector3D`	`GetPlaneOrientation ()` `LICENSE: 222`
`AnnotationPlaneType`	`GetPlaneType ()`
`/optional/ Selection`	`GetReference ()`
`/optional/ String`	`GetViewName ()`
`boolean`	`IsForceToPlane ()`
`boolean`	`IsFrozen ()`
`/optional/ AnnotationPlane`	`SetForceToPlane (boolean ForceToPlane)`
`/optional/ AnnotationPlane`	`SetFrozen (boolean Frozen)`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Method Detail

GetReference

/*optional*/ Selection GetReference ()

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation plane does not contain a reference plane (annotation was created using a drawing view's default orientation as its annotation plane).

XToolkitEmpty - The annotation plane orientation is frozen with respect to the reference, and the reference is currently missing from the model.

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

Returns:

GetPlaneData

WPlaneData GetPlaneData ()

Exceptions thrown (but not limited to):

XToolkitBadContext - The annotation plane is flat-to-screen.

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

Returns:

GetNormalVector

Vector3D GetNormalVector ()

Exceptions thrown (but not limited to):

XToolkitBadContext - The annotation plane is flat-to-screen.

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

Returns:

GetViewName

/*optional*/ String GetViewName ()

Exceptions thrown (but not limited to):

XToolkitNotFound - The annotation plane was created from a named view in the model or drawing, but that view is no longer accessible.

XToolkitBadContext - The annotation plane was not created from a named view in the model or drawing.

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

Returns:

SetForceToPlane

/*optional*/ AnnotationPlane SetForceToPlane (boolean ForceToPlane)

Exceptions thrown (but not limited to):

XToolkitBadContext - The annotation plane is not governed by a reference.

XToolkitNoChange - No change was made - the same value of the force-to-plane property is already set.

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

Parameters:

ForceToPlane

Returns:

IsForceToPlane

boolean IsForceToPlane ()

Exceptions thrown (but not limited to):

XToolkitBadContext - The annotation plane is not governed by a reference.

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

Returns:

GetPlaneType

AnnotationPlaneType GetPlaneType ()

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

Returns:

SetFrozen

/*optional*/ AnnotationPlane SetFrozen (boolean Frozen)

Exceptions thrown (but not limited to):

XToolkitBadContext - The annotation plane is not governed by a reference.

XToolkitNoChange - The annotation plane is already frozen (or not frozen), no change was made.

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

Parameters:

Frozen

Returns:

IsFrozen

boolean IsFrozen ()

Exceptions thrown (but not limited to):

XToolkitBadContext - The annotation plane is not governed by a reference.

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

Returns:

GetNames

/*optional*/ stringseq GetNames ()

Get the names corresponding to the annotation plane.

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

Returns:: Names of the annotation plane

AssignName

void AssignName (String AnnotationPlaneName)

Assigns name to annotation plane.

Exceptions thrown (but not limited to):

<reference 6 to unknown entity pfcExceptions::pfcXToolkitFound> - Annotation plane with same name already exist.

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

Parameters:

AnnotationPlaneName: Name of the annotation plane

Returns:

GetPlaneAngle

double GetPlaneAngle ()

LICENSE: 222

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

Returns:

GetPlaneOrientation

Vector3D GetPlaneOrientation ()

LICENSE: 222

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

Returns:

GetFlip

boolean GetFlip ()

LICENSE: 222

Get the 'Flip' property of an annotation plane.

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

Returns:: True if the annotation plane has 'Flip' property.