About Annotation Templates

Basic Concepts

Annotations such as grid, elevation, spot, etc. use annotation templates. A template is an extended 2D component in a detail sheet. For more information about 2D components, see 3D Modeling: Mechanical Systems: Drafting User's Guide: Working with 2D Components: Creating a 2D Component Reference.

The templates are supported by the annotations, only when the template is created in a detail sheet using the Annotation Template command.

This command creates a new 2D component in the current detail sheet. This 2D component contains the following:

• A parameter set under which all template parameters are aggregated.
• An hidden parameter named ID within this set, to identify the template.
• A relation set under which all template formulas and rules are aggregated.

Rules:

• The template can contain drafting annotations. The following drafting annotations are supported:
  • Text
  • Text with leader
  • Arrow
  • Area Fill
• The template can contain geometry (only line and circle).
• The template can contain dimensions driving the geometry.
• The template can contain knowledge parameters under the Parameters node, and possible formulas and rules under the Relations node.
• The template can contain a picture that is displayed in the creation and edition panel.

A drawing can contain one or several annotation templates, this means you can have one or several detail sheets with one or several 2D component references representing templates in a single drawing.

Select an annotation template and click the annotation template command to edit it.

You can define layer values to an annotation template. Right-click the annotation template and select Properties > Graphic. Under Global Properties, define a value from the Layers list.

Parameters

Annotation templates have knowledge parameters that are used to expose the parameters to create an annotation or to drive the template.

You can create parameters under the parameters node in the following ways:

• Edit the template and opening the parameter explorer from edition panel.
• Create parameters using , and cutting and pasting them under the Parameters node.

For example, if you want to expose the length of an annotation or the number of lines, you can create a knowledge parameter.

The following types of parameter can be created:

• Visible parameters: Available in the annotation edition panel.
• Hidden parameters: Not available in the annotation edition panel.
• Locked/Constant parameters: Available in the annotation edition panel but not editable.

The following specific parameters that are computed from annotation instance can be used and set in the template:

Name	Type	Value	Description
RelativePositionX	Length	Computed	In template context, the parameter that gives the relative position of an annotation along X with regards to insert point.
RelativePositionY	Length	Computed	In template context, the parameter that gives the relative position of an annotation along Y with regards to insert point.

Relations

Annotation template can have knowledge relations (formulas, rules, or actions) used to drive it and add particular behavior that can editable through parameters.

Relations have to be added under the Relations node:

1. Create a relation.
2. The relation is added to the Relations set under root.
3. Cut and paste it under the Relations node under the template.

The action to trigger the annotation update that it valuates a parameter from the Parameters node with a value different for each action result. Or else, annotation is not updated when the action is processed.

Geometry

Annotation template can contain a drafting geometry (only line and circle).

To drive geometry, it is recommended to use knowledge rules and functions from ASD drafting functions rather than dimensions that can have unpredictable behavior.

The available functions are as follows:

• Point->GetCoord(X:out Length, Y:out Length):Boolean
• Point->SetCoord(X: Length, Y: Length):Boolean
• Line->GetPoints(Point1_H:out Length, Point1_V:out Length, Point2_H:out Length, Point2_V:out Length):Boolean
• Line->SetPoints(Point1_H: Length, Point1_V: Length, Point2_H: Length, Point2_V: Length):Boolean
• Circle->SetCenterRadius(Point1_H: Length, Point1_V: Length, Radius: Length):Boolean
• Circle->GetCenterRadius (Point1_H: out Length, Point1_V: out Length, Radius: out Length): Boolean
• Circle->Set3Points (Point1_H: Length, Point1_V: Length, Point2_H: Length, Point2_V: Length, Point3_H: Length, Point3_V: Length, Trim: nteger): Boolean

The first geometric line in an annotation template is set as the published shape in the instantiated annotation. This published shape is selectable and available for annotating (dimensioning, leader anchor point, etc.).

Annotations

Annotation template can contain a drafting annotation (only text, arrow, and area fill).

To drive geometry, it is recommended to use knowledge rules and functions from ASD drafting functions rather than dimensions that can have unpredictable behavior.

The available functions are as follows:

• Text->GetPosition(X:out Length, Y:out Length):Boolean
• Text->SetPosition(X: Length, Y: Length):Boolean
• Text->SetPositionWithAnchor(X: Length, Y: Length, AnchorPoint:Integer,...):Boolean
• Text->SetFontSize(Size:Real):Boolean
• Text->SetJustification(Justification:Ineteger):Boolean
• Text->SetWrapping(WrapMode:Integer, Width:Real):Boolean

Text template is also managed by the annotation template. It contains the link templates which are resolved with either of the following:

• The selected annotation input feature
• It's representation instance
• Any occurrence up to the root product.

Leader

The leader is supported by the annotation only when it is defined in the template.