Class FluteContour

Namespace

Hi.Milling.FluteContours

Assembly

HiMech.dll

Represents a flute contour for milling tools.

public class FluteContour : IMakeXmlSource, IDisposable, IClearCache

Inheritance

object

FluteContour

Implements

IMakeXmlSource

IDisposable

IClearCache

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

FluteContour()

Initializes a new instance of the FluteContour class

public FluteContour()

FluteContour(FluteContour, double)

Initializes a new instance of the FluteContour class with a source contour and shift angle

public FluteContour(FluteContour src, double shiftAngle_rad)

Parameters

src FluteContour

The source flute contour to copy from

shiftAngle_rad double

The shift angle in radians

FluteContour(XElement, string, params object[])

Initializes a new instance of the FluteContour class from XML data

public FluteContour(XElement src, string baseDirectory, params object[] res)

Parameters

src XElement

The source XML element

baseDirectory string

The base directory for resolving relative paths

res object[]

Additional resources for initialization

Properties

BaseBottomContour

Gets or sets the base bottom contour of the flute. This represents the original bottom profile before any transformations.

public IWorkingContour BaseBottomContour { get; set; }

Property Value

IWorkingContour

BaseSideContour

Gets or sets the base side contour of the flute. This represents the original side profile before any transformations.

public IWorkingContour BaseSideContour { get; set; }

Property Value

IWorkingContour

SetupAngle_deg

Gets or sets the setup angle in degrees. This is a convenience property that converts ShiftAngle_rad to degrees.

public double SetupAngle_deg { get; set; }

Property Value

double

ShiftAngle_rad

Gets or sets the shift angle in radians. This angle represents the angular offset of the flute from its base position.

public double ShiftAngle_rad { get; set; }

Property Value

double

ShiftedBottomContour

Gets the shifted bottom contour of the flute. This is the bottom profile after applying the shift angle transformation.

public ShiftedWorkingContour ShiftedBottomContour { get; }

Property Value

ShiftedWorkingContour

ShiftedSideContour

Gets the shifted side contour of the flute. This is the side profile after applying the shift angle transformation.

public ShiftedWorkingContour ShiftedSideContour { get; }

Property Value

ShiftedWorkingContour

XName

Gets the XML name for serialization

public static string XName { get; }

Property Value

string

Methods

ClearCache()

Clears any cached data in the flute contour

public void ClearCache()

Dispose()

Releases all resources used by the FluteContour

public void Dispose()

Dispose(bool)

Releases the unmanaged resources used by the FluteContour and optionally releases the managed resources

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources

Duplicate(IGetZrList)

Creates a duplicate of this flute contour

public FluteContour Duplicate(IGetZrList zrListHost)

Parameters

zrListHost IGetZrList

The host containing Z-R list information

Returns

FluteContour

A new instance of FluteContour with the same properties

ExpandToBox3d(Box3d)

Expands the given bounding box to include this flute contour

public void ExpandToBox3d(Box3d dst)

Parameters

dst Box3d

The bounding box to expand

MakeXmlSource(string, string, bool)

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, bool exhibitionOnly)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

exhibitionOnly bool

if true, the extended file creation is suppressed.

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.

UpdateByContent()

Updates the internal state based on the current content

public void UpdateByContent()