Class vdArcAlignedText
- Namespace
- VectorDraw.Professional.vdFigures
- Assembly
- VectorDraw.Professional.dll
Represents a text object whose characters are positioned and rotated to follow an arc.
public class vdArcAlignedText : vdFigure, IDisposable, IVDSerialise, IBaseObject- Inheritance
-
vdArcAlignedText
- Implements
- Inherited Members
Examples
Example of creating a vdArcAlignedText object and linking it to a vdArc as reference object.
When the arc is modified the text will be updated accordingly.
var arc = new vdArc(doc, new gPoint(0, 0, 0), 100.0, 0.0, Math.PI / 2);
doc.Model.Entities.AddItem(arc);
var arcText = new vdArcAlignedText(doc)
{
TextString = "Hello VectorDraw",
//Center = new gPoint(0, 0, 0),
//Radius = 100.0,
//StartAngle = 0.0,
//EndAngle = Math.PI / 2,
ReferenceObj = arc,
Height = 10.0,
Orientation = vdArcAlignedText.OrientationEnum.FitToArc,
Side = vdArcAlignedText.SideEnum.Above
};
doc.Model.Entities.AddItem(arcText);Remarks
The vdArcAlignedText class breaks a text string into individual vdText items and places each character along a circular arc specified by Center, Radius, StartAngle and EndAngle. The class supports multiple orientation modes (vdArcAlignedText.OrientationEnum) and can render text on either side of the arc (vdArcAlignedText.SideEnum).
Key behaviors:
- Characters are positioned in object coordinates and then transformed to world coordinates using ECSMatrix.
- Use ArcOffset, LeftOffset and RightOffset to adjust spacing from the arc and ends.
- When AlignToView is true the object plane is aligned to the current view; use AlignToViewSize to control screen-size behavior.
- The object can be linked to a reference arc (ReferenceObj). When the referenced arc changes (radius, center, extrusion),
this object updates itself automatically.
When linked to a reference arc, properties like Center, Radius, StartAngle, EndAngle and ExtrusionVector are overridden by the corresponding properties of the reference arc.
Constructors
- vdArcAlignedText()
Initializes a new instance of the vdArcAlignedText object.
- vdArcAlignedText(vdDocument)
Initializes a new instance of the vdArcAlignedText object and registers it to the passed Document.
- vdArcAlignedText(vdDocument, string, double, gPoint, double)
Initializes a new instance of the vdArcAlignedText object using the passed parameters.
- vdArcAlignedText(vdDocument, string, double, gPoint, double, double, double)
Initializes a new instance of the vdArcAlignedText object using the passed parameters.
Properties
- AlignToView
A boolean value that defines if the plane of the object is relative to the current view.
- AlignToViewSize
Get/Set the height of the object in output Device millimeters for positive or hundreds of millimeters for negative.
- ArcOffset
Offset distance for the text from the text's arc.
- Bold
Get/Set a boolean value indicating if the text is bold.
- BoundingBox
Gets the Bounding Box of the vdArcAlignedText object in WorldCoordinate System.
- Center
Get/Set the Center of the vdArcAlignedText object.
- ECSMatrix
Gets the transformation Matrix that converts coordinates from the object's local coordinate system (object coordinate system, OCS) to the World Coordinate System (WCS).
- EndAngle
Get/Set the end angle of the vdArcAlignedText object.
- ExtrusionVector
Get/Set the 3D vector extrusion direction for the object.
- Height
Get/Set the height of the text in drawing units.
- IsClockWise
Get/Set a value that represents if the text is drawn reversed regarding the arc's orientation.
- LeftOffset
Offset distance for the beginning of the text.
- ObliqueAngle
Oblique angle for the text in degrees.
- Orientation
Specifies the orientation that the arc will be drawn.
- Radius
Get/Set the radius of the vdArcAlignedText object.
- ReferenceObj
The reference Object of the vdDimension
- RightOffset
Offset distance for the end of the text.
- Side
Specifies the side that the arc will be drawn , above or below the arc.
- StartAngle
Get/Set the start angle of the vdArcAlignedText object.
- Style
Get/Set the vdTextstyle object of the vdArcAlignedText.
- TextLine
Specifies if any lines will be drawn with the text using grTextStyleExtra.TextLineFlags flag.
- TextString
Get/Set the string that the vdArcAlignedText object will draw.
- Thickness
Get/Set the object's thickness in Drawing Units.
- WidthFactor
Get/Set a value used to stretch the vdArcAlignedText object by changing it's width.
- param1
This is not used for this object
Methods
- DeSerialize(DeSerializer, string, object)
This Function is called foreach field name of the vdArcAlignedText object when opening in vdml format.
- Dispose()
Releases all resources used by this object.
- Draw(vdRender)
Called in order to draw the object in a specified vdRender object.
- Explode()
Explodes the vdArcAlignedText object into many vdText objects.
- GetCompareHash()
Returns a unique 32 bit integer value according to the object type and its properties values
- GetDisplayString()
Gets the string that is displayed.
- GetGripPoints()
A function returning the grip points of the object.
- GetTableDependecies(vdTableDependeciesArgs)
Fills the passed vdTableDependeciesArgs args with all the table references of this object (vdLayer, vdBlock, vdDimstyle, vdLineType, vdTextstyle, vdImageDef, vdHatchPattern etc).
- GetValidGripPointsItems()
Returns the number of valid grip points of the object. Must return the same number of points as the GetGripPoints() method.
- InitializeProperties()
Resets the properties of the vdArcAlignedText object to the Default values.
- InternalSetOwner(vdBaseObject)
Internally used only.
Set the object owner
- Invalidate()
Invalidates the object's Bounding Box and causes the control to be redrawn in this region.
- MatchProperties(vdPrimary, vdDocument)
Matches all the common properties from an object and sets them to this object.
- MoveGripPointsAt(Int32Array, double, double, double)
This function is intended to be called during a grip edit of the object.
- Serialize(Serializer)
This Function is called when saving the vdArcAlignedText object to vdml format.
- SetPropertiesFromArc(vdArc)
Sets the properties of this vdArcAlignedText object from the passed arc.
- ShouldBeTransformed(vdSelection, bool)
This method is used in order to determine what should happen when a transformBy occurs in a collection.
- ToString()
Gets a System.String that represents the type of the vdArcAlignedText Object.
- Transformby(Matrix)
Transforms all geometrical properties of this object by the specified Matrix.
- Update()
Updates the object after change of properties.