CIP C++ documentation for class "wfcAnnotationPlane"

Class wfcAnnotationPlane

# include <wfcAnnotation.h> class wfcAnnotationPlane : public virtual wfcWModelItem { xaideclare(wfcAnnotationPlane) ... };

Description

Manual References:: Annotations: Annotation Features and Annotations: Baseline Dimensions, Annotations: Geometric Tolerances: Attaching the Geometric Tolerances

Method Summary


`void`	`AssignName (xrstring AnnotationPlaneName)`
	Assigns name to annotation plane.

`xbool`	`GetFlip ()`
	LICENSE: 222 Get the 'Flip' property of an annotation plane.

`optional xstringsequence_ptr`	`GetNames ()`
	Get the names corresponding to the annotation plane.

`pfcVector3D_ptr`	`GetNormalVector ()`


`xreal`	`GetPlaneAngle ()`
	LICENSE: 222

`wfcWPlaneData_ptr`	`GetPlaneData ()`


`pfcVector3D_ptr`	`GetPlaneOrientation ()`
	LICENSE: 222

`wfcAnnotationPlaneType`	`GetPlaneType ()`


`optional pfcSelection_ptr`	`GetReference ()`


`optional xstring`	`GetViewName ()`


`xbool`	`IsForceToPlane ()`


`xbool`	`IsFrozen ()`


`optional wfcAnnotationPlane_ptr`	`SetForceToPlane (xbool ForceToPlane)`


`optional wfcAnnotationPlane_ptr`	`SetFrozen (xbool Frozen)`

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Method Detail

optional pfcSelection_ptr GetReference ()

Exceptions thrown (but not limited to):

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

pfcXToolkitEmpty - 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:

wfcWPlaneData_ptr GetPlaneData ()

Exceptions thrown (but not limited to):

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

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

Returns:

pfcVector3D_ptr GetNormalVector ()

Exceptions thrown (but not limited to):

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

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

Returns:

optional xstring GetViewName ()

Exceptions thrown (but not limited to):

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

pfcXToolkitBadContext - 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:

optional wfcAnnotationPlane_ptr SetForceToPlane (xbool ForceToPlane)

Exceptions thrown (but not limited to):

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

pfcXToolkitNoChange - 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:

xbool IsForceToPlane ()

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - 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:

wfcAnnotationPlaneType GetPlaneType ()

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

Returns:

optional wfcAnnotationPlane_ptr SetFrozen (xbool Frozen)

Exceptions thrown (but not limited to):

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

pfcXToolkitNoChange - 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:

xbool IsFrozen ()

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - 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:

optional xstringsequence_ptr 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

void AssignName (xrstring AnnotationPlaneName)

Assigns name to annotation plane.

Exceptions thrown (but not limited to):

<reference 4 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:

xreal GetPlaneAngle ()

LICENSE: 222

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

Returns:

pfcVector3D_ptr GetPlaneOrientation ()

LICENSE: 222

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

Returns:

xbool 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.