Class vdHelix
- Namespace
- VectorDraw.Professional.vdFigures
- Assembly
- VectorDraw.Professional.dll
Represents a three-dimensional helical curve used by the VectorDraw framework.
public class vdHelix : vdCurve, IDisposable, IVDSerialise, IBaseObject- Inheritance
-
vdHelix
- Implements
- Inherited Members
Examples
Example usage:
// create a helix registered to a document
var helix = new vdHelix(document) {
BaseRadius = 10.0,
TopRadius = 5.0,
Turns = 4.0,
Height = 80.0,
StartAngle = 0.0,
Twist = VdConstHelixTwist.CounterClockWise
};
document.Model.Entities.AddItem(helix);Remarks
The vdHelix class encapsulates the geometric definition of a helix:
base and top radii, overall height, per-turn height, number of turns, start angle,
twist direction and the property used as constraint when related properties change.
The object participates in the document's serialization and undo/redo history and raises document modification events
when mutable properties change.
Many editing operations common to other curve types (for example offset, trim, extend, ToMesh) are intentionally unsupported by this type and return null/false accordingly.
Constructors
- vdHelix()
Initializes a new instance of the vdHelix object.
- vdHelix(vdDocument)
Initializes a new instance of the vdHelix object and registers it to the passed Document.
Properties
- BaseCenter
Get/Set the Center of the base of the vdHelix object in World Coordinate System.
- BaseRadius
Get/Set the Base radius of the vdHelix object.
- BoundingBox
Gets the Bounding Box of the vdHelix object in WorldCoordinate System.
- Constrain
Get/Set a flag indicating the property that will be constrained when other properties change.
- 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).
- Height
Get/Set the Height of the vdHelix object.
- StartAngle
Get/Set the start angle of the vdHelix object.
- Thickness
Does not implement vdCurves Thickness because it has no meaning.
- TopRadius
Get/Set the Top radius of the vdHelix object.
- TurnHeight
Get/Set the Height for each turn of the vdHelix object.
- Turns
Get/Set the Turns of the vdHelix object.
- Twist
Get/Set a flag indicating the way the helix will turn.
Methods
- Area()
Area calculation is not supported.
- Break(gPoint, gPoint, out vdFigure)
Break command is not supported!
- DeSerialize(DeSerializer, string, object)
This Function is called foreach field name of the vdHelix object when opening in vdml format.
- Draw(vdRender)
Called in order to draw the object in a specified vdRender object.
- Explode()
Explodes the vdHelix object into a vdPolyline.
- Extend(vdSelection, gPoint)
Extend is not supported.
- Extend(vdSelection, gPoint, bool)
Extend is not supported.
- GetCompareHash()
Returns a unique 32 bit integer value according to the object type and its properties values
- GetGripPoints()
A function returning the grip points of the object.
- GetSamplePoints(int, double)
Returns a list of points on the vdHelix object from the start to the end point of the curve.
- 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 vdHelix object to the Default values.
- Length()
Provides an approximation of the length of the Helix.
- 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 vdHelix object.
- Serialize(Serializer)
This Function is called when saving the vdHelix object to vdml format.
- TestOffsetSide(gPoint)
Returns 0.0 since offset is not supported.
- ToMesh(int)
ToMesh is not supported.
- Transformby(Matrix)
Transforms all geometrical properties of this object by the specified Matrix.
- Trim(vdSelection, gPoint, out vdCurve)
Trim command is not supported.
- Trim(vdSelection, gPoint, out vdCurve, bool)
Trim command is not supported.
- Update()
Updates the object after change of properties.
- getEndParam()
Return the end parameter for the vdHelix object.
- getEndPoint()
Get the last point of the Helix.
- getOffsetCurve(double)
Offset command is not supported by the Helix Object.
- getOsnapPoints(Matrix, OsnapMode, gPoint, gPoint, int, OsnapPoints)
Overrrides the getOsnapPoints(Matrix, OsnapMode, gPoint, gPoint, int, OsnapPoints).
- getStartParam()
Returns the start parameter for the vdHelix object.
- getStartPoint()
Get the first point of the helix.