Table of Contents

Class GeneralXyzabcMachineTool

Namespace
Hi.NcMech.Xyzabc
Assembly
HiMech.dll

General implementation of an XYZABC machine tool.

public class GeneralXyzabcMachineTool : IXyzabcMachineTool, IDisplayee, IGetCollisionIndexPairs, IXyzabcChain, IGetXyzabcChain, IMachiningChain, IGetAsmb, IGetAnchor, IGetTopoIndex, IMakeXmlSource, IGetAnchorToSolidDictionary, IGetAnchoredDisplayeeList, IExpandToBox3d, INameNote
Inheritance
GeneralXyzabcMachineTool
Implements
Inherited Members
Extension Methods

Constructors

GeneralXyzabcMachineTool(IXyzabcChain)

Initializes a new instance of the GeneralXyzabcMachineTool class.

public GeneralXyzabcMachineTool(IXyzabcChain xyzabcChain)

Parameters

xyzabcChain IXyzabcChain

XYZABC chain to use.

GeneralXyzabcMachineTool(XElement, string)

Initializes a new instance of the GeneralXyzabcMachineTool class from XML.

public GeneralXyzabcMachineTool(XElement src, string baseDirectory)

Parameters

src XElement

XML element source.

baseDirectory string

Base directory.

Fields

XName

Name of XML element.

public static string XName

Field Value

string

Properties

CollisionIndexPairs

Collection of collision index pairs for collision detection.

public HashSet<CollisionIndexPair> CollisionIndexPairs { get; }

Property Value

HashSet<CollisionIndexPair>

EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded

Gets or sets whether to automatically generate collision index pairs when loaded from XML.

public bool EnableAutoGeneratingCollisionIndexPairsOnXmlLoaded { get; set; }

Property Value

bool

McCodes

Gets the machine coordinate code sequence for decoding the MC array.

public string[] McCodes { get; }

Property Value

string[]

McTransformers

Gets the machine coordinate transformers.

public IDynamicRegular[] McTransformers { get; }

Property Value

IDynamicRegular[]

Name

Gets or sets the name of the object.

public string Name { get; set; }

Property Value

string

Note

Gets or sets the descriptive note for the object.

public string Note { get; set; }

Property Value

string

TableAnchor

Anchor to attach fixture or workpiece. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetTableBuckle.

public Anchor TableAnchor { get; }

Property Value

Anchor

ToolAnchor

Anchor to attach tool. The anchor is the same as IXyzabcChain.Hi.Numerical.Xyzabc.IXyzabcChain.GetToolBuckle.

public Anchor ToolAnchor { get; }

Property Value

Anchor

XyzabcChain

XYZABC chain for this machine tool.

public IXyzabcChain XyzabcChain { get; }

Property Value

IXyzabcChain

XyzabcChainFile

File path for XYZABC chain.

public string XyzabcChainFile { get; set; }

Property Value

string

Methods

Display(Bind)

Display function called in DispEngine rendering loop.

public void Display(Bind bind)

Parameters

bind Bind

Bind with DispEngine. See Bind.

ExpandToBox3d(Box3d)

Expands the destination box. This function is usually used to compute the bounding box of elements.

public void ExpandToBox3d(Box3d dst)

Parameters

dst Box3d

Destination box

GetAnchor()

Get key anchor. (i.e. root anchor)

public Anchor GetAnchor()

Returns

Anchor

key anchor

GetAnchorToSolidDictionary()

Gets a dictionary that maps Anchor objects to their corresponding Solid objects.

public Dictionary<Anchor, Solid> GetAnchorToSolidDictionary()

Returns

Dictionary<Anchor, Solid>

A dictionary where keys are anchors and values are their associated solids.

GetAnchoredDisplayeeList()

Gets a list of anchored displayable objects.

public List<IAnchoredDisplayee> GetAnchoredDisplayeeList()

Returns

List<IAnchoredDisplayee>

A list of IAnchoredDisplayee objects

GetAsmb()

Gets the key asmb.

public Asmb GetAsmb()

Returns

Asmb

The key asmb.

GetCollisionIndexPairs()

Gets a collection of collision index pairs for collision detection.

public IEnumerable<CollisionIndexPair> GetCollisionIndexPairs()

Returns

IEnumerable<CollisionIndexPair>

A collection of CollisionIndexPair objects.

GetMachiningChain()

public IMachiningChain GetMachiningChain()

Returns

IMachiningChain

GetMcCodeTransformerDictionary()

public Dictionary<string, IDynamicRegular> GetMcCodeTransformerDictionary()

Returns

Dictionary<string, IDynamicRegular>

GetTableBuckle()

Gets the table buckle anchor point.

public IGetAnchor GetTableBuckle()

Returns

IGetAnchor

The table buckle anchor point.

GetToolBuckle()

Gets the tool buckle anchor point.

public IGetAnchor GetToolBuckle()

Returns

IGetAnchor

The tool buckle anchor point.

GetTransformerA()

Get transformer A.

public DynamicRotation GetTransformerA()

Returns

DynamicRotation

transformer A

GetTransformerB()

Get transformer B.

public DynamicRotation GetTransformerB()

Returns

DynamicRotation

transformer B

GetTransformerC()

Get transformer C.

public DynamicRotation GetTransformerC()

Returns

DynamicRotation

transformer C

GetTransformerX()

Get transformer X.

public DynamicTranslation GetTransformerX()

Returns

DynamicTranslation

transformer X

GetTransformerY()

Get transformer Y.

public DynamicTranslation GetTransformerY()

Returns

DynamicTranslation

transformer Y

GetTransformerZ()

Get transformer Z.

public DynamicTranslation GetTransformerZ()

Returns

DynamicTranslation

transformer Z

GetXyzabcChain()

public IXyzabcChain GetXyzabcChain()

Returns

IXyzabcChain

IXyzabcChain

GetXyzabcMachineTool()

public GeneralXyzabcMachineTool GetXyzabcMachineTool()

Returns

GeneralXyzabcMachineTool

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 string

The base directory for resolving relative paths

relFile string

The 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.