AnnotationPlaneDefinition Object


Description

The AnnotationPlaneDefinition object represents the information used to define an annotation plane. It’s not the actual annotation plane, but only the definition of a plane.

Methods

Name Description
AnnotationPlaneToModel Method that takes a 2d coordinate in annotation plane space, and returns a Point3d containing the coordinates of the point in model space.
Copy Method that creates a copy of this AnnotationPlaneDefinition object. The new AnnotationPlaneDefinition object is independent any annotation plane. It can edited and used as input to edit an existing annotation plane or to create a new annotation plane.
ModelToAnnotationPlane Method that takes a 3d coordinate in model space, projects it onto the annotation plane along the normal of the plane and returns a Point2d object containing the resulting coordinate point in annotation plane space.

Properties

Name Description
Application Gets the root Application object. Where the property is weakly-typed, it can be set to (QueryInterfaced for) 'Application' when running with Inventor whereas, 'ApprenticeServer' when running with the Apprentice Server.
Origin Read-only property that returns origin of the annotation plane in model space.
Parent Read-only property that returns the parent annotation plane this definition is associated with. This property can be Nothing in the case the definition was created using either the CreateAnnotationPlaneDefinitionUsingIntents or CreateAnnotationPlaneDefinitionUsingPlane methods of the ModelAnnotations object.
PlanarEntity Read-only property that returns the planar entity the annotation plane is associated with. This property can return Nothing in the case it’s not associated with a planar entity.
Plane Read-only property that returns the plane geometry indicating the position and orientation of the annotation plane in model space.
Transformation Read-only property that returns a matrix indicating the position and orientation of the annotation plane in model space.
Type Read-only property returning kAnnotationPlaneDefinitionObject indicating this object’s type.
XAxis Read-only property that returns the orientation of the x axis of the annotation plane in model space.
XAxisEntity Read-write property that sets and gets the entity that defines the x axis of the annotation plane.
XAxisRotation Read-write property that gets and sets the rotation of the x-axis in radians against the XAxisEntity. Valid value is in (-Pi, Pi].

Accessed From

AngularModelDimensionDefinition.AnnotationPlaneDefinition, AnnotationPlane.Definition, AnnotationPlaneDefinition.Copy, AnnotationPlaneDefinitionsEnumerator.Item, AnnotationPlaneProxy.Definition, DiameterModelDimensionDefinition.AnnotationPlaneDefinition, LinearModelDimensionDefinition.AnnotationPlaneDefinition, ModelAnnotations.CreateAnnotationPlaneDefinitionUsingPlane, ModelDatumIdentifierDefinition.AnnotationPlaneDefinition, ModelDimensionDefinition.AnnotationPlaneDefinition, ModelFeatureControlFrameDefinition.AnnotationPlaneDefinition, ModelGeneralNoteDefinition.AnnotationPlaneDefinition, ModelHoleThreadNoteDefinition.AnnotationPlaneDefinition, ModelLeaderNoteDefinition.AnnotationPlaneDefinition, ModelSurfaceTextureSymbolDefinition.AnnotationPlaneDefinition, ModelWeldingSymbolDefinitions.AnnotationPlaneDefinition, RadiusModelDimensionDefinition.AnnotationPlaneDefinition

Version

Introduced in version 2018