Class CustomSpinningProfile
Represents a custom spinning profile for a milling cutter. This profile allows for custom geometry to be used as the cutter profile. Internal Use Only
public class CustomSpinningProfile : IShaperProfile, IMakeXmlSource, IAbstractNote, IGetStl, IGetZrList, IDuplicate, IClearCache
- Inheritance
-
CustomSpinningProfile
- Implements
- Inherited Members
- Extension Methods
Constructors
CustomSpinningProfile(MillingCutter)
Ctor
public CustomSpinningProfile(MillingCutter host)
Parameters
host
MillingCutter
CustomSpinningProfile(XElement, string, MillingCutter, params object[])
Initializes a new instance of the CustomSpinningProfile class.
public CustomSpinningProfile(XElement element, string baseDirectory, MillingCutter host, params object[] res)
Parameters
element
XElementThe XML element containing profile data.
baseDirectory
stringThe base directory for resolving relative paths.
host
MillingCutterThe host milling cutter.
res
object[]Additional resolution parameters.
Properties
AbstractNote
Gets the abstract note describing the profile. Internal Use Only
public string AbstractNote { get; }
Property Value
Geom
Gets or sets the geometry that defines the profile. Internal Use Only
public IGetStl Geom { get; set; }
Property Value
Host
Gets or sets the associated milling cutter. Internal Use Only
public MillingCutter Host { get; set; }
Property Value
XName
Name for XML IO.
public static string XName { get; }
Property Value
Methods
ClearCache()
Clears any cached data. Internal Use Only
public void ClearCache()
Duplicate(params object[])
Creates a deep copy of the object, excluding any source file references.
public object Duplicate(params object[] res)
Parameters
res
object[]Optional parameters that may be needed during the duplication process
Returns
- object
A new instance that is a deep copy of the original object
GetStl()
Gets the STL mesh representation of the profile. Internal Use Only
public Stl GetStl()
Returns
- Stl
The STL mesh
GetZrList()
Gets the ZR contour list for the profile. This method attempts to get the ZR list from various geometry types. Internal Use Only
public List<PairZr> GetZrList()
Returns
MakeXmlSource(string, string)
Creates an XML representation of the object. This method may also generate additional resources such as related files.
public XElement MakeXmlSource(string baseDirectory, string relFile)
Parameters
baseDirectory
stringThe base directory for resolving relative paths
relFile
stringThe relative file path for the XML source
Returns
- XElement
An XML element representing the object's state
Remarks
For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied.
The baseDirectory
is typically the folder at the nearest configuration file folder.
Since the folder can be moving with the configuration file.