Drawing3d documented Class Library

Circle3D Members

Circle3D overview

Public Instance Constructors

Circle3D Constructor An empty contructor. It sets the resolution to 40

Public Instance Fields

OnChanged (inherited from Curve3D) This event is fired by the method Changed
Tag (inherited from Curve3D) Tag is a free programmable property

Public Instance Properties

A (inherited from Curve3D) Gets the starting point of the curve by calling getA.
Atang (inherited from Curve3D) Returns and sets the start tangent. See getAtang and Btang
B (inherited from Curve3D) Gets the endpoint of the curve by calling getB.
Base This property holds the base for the circle. It will be drawn in the xy-plane
Btang (inherited from Curve3D) Returns and sets the end tangent. See getBtang and Atang.
Clockwise Gets and sets the orientation of the circle.
Closed (inherited from Curve3D) Gets and sets the information, that the curve is closed, ie A = B.
CurveLength (inherited from Curve3D) Retrieves the length of the curve.
fromParam (inherited from Curve3D) Retrieves and sets the starting parameter. All parameters are within the interval [fromParam, toParam]. Initial value is 0;
Maxrect (inherited from Curve3D) A property, which calls GetMaxrect
Neighbors (inherited from Curve3D) If a Curve3D is a contur curve of a Face this array contains both Neighbors. In generally this are two.
Radius Gets or sets the Raius of the Circle
Resolution (inherited from Curve3D) Retrieves and sets the resolution of the curve. The default value is 20.
toParam (inherited from Curve3D) Retrieves and sets the end parameter. All parameters are within the interval [fromParam, toParam]. Initialvalue is 1;
Visible (inherited from Curve3D) Several classes use this property and hide a curve, where visible is false.

Public Instance Methods

Changed (inherited from Curve3D) This method is called, when the curve is changed. It fires the event OnChanged
Clone (inherited from Curve3D) Produces an exact copy of the curve by using the BinaryFormatter. So you have to mark a new instance of Curve with the attribute [Serializable].
Copy Overrides the Copy method and copies the Base and the Radius.
Derivation Overrides the Derivation-method.
Distance (inherited from Curve3D)Overloaded. This method calculates the distance of a LineType to a Curve only in case, when the distance is smaller then MaxDist, otherwise big will be returned. You can imagine a cylinders with radius MaxDist around the Curve. If the line goes through the "curved" cylinder, then the distance will be calculated and returned.
Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetMaxrect (inherited from Curve3D)Overloaded. Gets a minimal Box, which contains a curve, transformed by a transformation.
GetType (inherited from Object) 
InsertPoint (inherited from Curve3D) Inserts a point at the position, which is given by Param.
Invert (inherited from Curve3D) Inverts the orientation of a curve. The base-method is empty. You should override it in a derived class.
LengthToParam (inherited from Curve3D) Converts a length to a param, which can be used in the method Value.
NormalCross (inherited from Curve3D) Calculates a point of a Curve, which is nearest to "Point"
ParamToLength (inherited from Curve3D) Calculates the length of a part of the curve, which is given from 0 to the value param.
SetBorder Overreides the SetBorder-method. It projects at first the Points A and B to the Circle and sets then fromParam and toParam.
Slice (inherited from Curve3D) This method trims the curve to the part between "from" and "to". The base-method sets fromParam = from and toParam = to. In general this is not the best solution. So it is better to override this method without calling to the base method.
ToArray (inherited from Curve3D) This method fills values, calculated by the function Value in an array, starting at index.
ToString (inherited from Object) 
ToxyzArray Overrides the ToxyzArray-method
Transform (inherited from Curve3D) Transforms a Curve with the transformation given by m. The method in the base class is empty. So you have to override this function, if you want to transform a Curve.
Value Overrides the value function and implement the circle function. For a full Circle you have to take the parameter from 0 to 1. 1 is equivalent to 2*PI.

Protected Instance Methods

Finalize (inherited from Object) 
getA Overrides the getA-method and returns the value of a local variable.
getAtang (inherited from Curve3D) This method is the getMethod of the Atang-property, which retrieves the start tangent. By default Derivation(fromParam) is returned.
getB Overrides the getB-method and returns the value of a local variable.
getBtang (inherited from Curve3D) This method is the getMethod of the Btang-property, which retrieves the Endtangent. By default Derivaion(toParam) is returned.
GetMaxrect (inherited from Curve3D)Overloaded. Gets the smaller rectangle, which contains the curve.
getVisible (inherited from Curve3D) virtual getmethod of the property Visible
MemberwiseClone (inherited from Object) 
setA Overrides the setA-method and saves the value in a local variable.
setAtang (inherited from Curve3D) This is the virtual setter method of the property Atang
setB Overrides the setB-method and saves the value in a local variable.
setBtang (inherited from Curve3D) This is the virtual set method of the property B
SetClosed (inherited from Curve3D) Virtual Settermethod of Closed-property
setVisible (inherited from Curve3D) Virtual setmethod of the property Visible

See Also

Circle3D Class | Drawing3d.Curves Namespace