IMBA2_SDK_Document interface

No description yet.

public interface IMBA2_SDK_Document : IServerDocument

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IServerDocument

Methods

Method	Returns	Description
AddMate	IMBA2_SDK_MatingPair
AddMate2	IMBA2_SDK_MatingPair
AddMate3	IMBA2_SDK_MatingPair
AddMate4	IMBA2_SDK_MatingPair
AddMateWithSettings	IMBA2_SDK_MatingPair
AddMBAPart	IMBA2_SDK_ArrayList
AddPCBPart	IMBA2_SDK_Part
AddSTEPPart	IMBA2_SDK_Part
CalculateMateSettings	MBAMateSettingsWithOrientation
ConvertLocalToWorldDirection	MBAVec3
ConvertLocalToWorldPosition	MBAVec3
ConvertWorldToLocalDirection	MBAVec3
ConvertWorldToLocalPosition	MBAVec3
Export3DStep	void
FindFaceByRay	IMBA2_SDK_Face
FindFaceOfComponentByRay	IMBA2_SDK_Face
FindFaceOfPartByRay	IMBA2_SDK_Face
FindNearestMatingItemByRay	IMBA2_SDK_MatingItem
FindNearestMatingItemOfComponentByRay	IMBA2_SDK_MatingItem
FindNearestMatingItemOfFaceByRay	IMBA2_SDK_MatingItem
FindNearestMatingItemOfPartByRay	IMBA2_SDK_MatingItem
GetDataModel	IMBA2_SDK_DataModel
GetPart	IMBA2_SDK_Part
GetPartCount	int
GetSceneData	string
MeasureDistanceComponentToComponent	double
MeasureDistanceComponentToFace	double
MeasureDistanceFaceToFace	double
RemoveMate	bool
RemovePart	bool
SetMateOrientation	void
SetMateSettings	void
SetMateType	void
SetPartTransform	void
SetPartTransform_ForPreview	void
SetPartTransformByPartId	void
UpdateAllParts	void
UpdatePart	void

AddMate

No description yet.

IMBA2_SDK_MatingPair AddMate(IMBA2_SDK_MatingItem argItemA, IMBA2_SDK_MatingItem argItemB);

Parameter	Type	Passing
argItemA	IMBA2_SDK_MatingItem	value
argItemB	IMBA2_SDK_MatingItem	value

Returns: IMBA2_SDK_MatingPair

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

AddMate2

No description yet.

IMBA2_SDK_MatingPair AddMate2(IMBA2_SDK_MatingItem argItemA, IMBA2_SDK_MatingItem argItemB, TMBAMateType argMateType);

Parameter	Type	Passing
argItemA	IMBA2_SDK_MatingItem	value
argItemB	IMBA2_SDK_MatingItem	value
argMateType	TMBAMateType	value

Returns: IMBA2_SDK_MatingPair

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

AddMate3

No description yet.

IMBA2_SDK_MatingPair AddMate3(IMBA2_SDK_MatingItem argItemA, IMBA2_SDK_MatingItem argItemB, TMBAMateOrientation argMateOrientation);

Parameter	Type	Passing
argItemA	IMBA2_SDK_MatingItem	value
argItemB	IMBA2_SDK_MatingItem	value
argMateOrientation	TMBAMateOrientation	value

Returns: IMBA2_SDK_MatingPair

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

AddMate4

No description yet.

IMBA2_SDK_MatingPair AddMate4(IMBA2_SDK_MatingItem argItemA, IMBA2_SDK_MatingItem argItemB, TMBAMateType argMateType, TMBAMateOrientation argMateOrientation);

Parameter	Type	Passing
argItemA	IMBA2_SDK_MatingItem	value
argItemB	IMBA2_SDK_MatingItem	value
argMateType	TMBAMateType	value
argMateOrientation	TMBAMateOrientation	value

Returns: IMBA2_SDK_MatingPair

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

AddMateWithSettings

No description yet.

IMBA2_SDK_MatingPair AddMateWithSettings(IMBA2_SDK_MatingItem argItemA, IMBA2_SDK_MatingItem argItemB, TMBAMateType argMateType, TMBAMateOrientation argMateOrientation, MBAMateSettings argMateSettings);

Parameter	Type	Passing
argItemA	IMBA2_SDK_MatingItem	value
argItemB	IMBA2_SDK_MatingItem	value
argMateType	TMBAMateType	value
argMateOrientation	TMBAMateOrientation	value
argMateSettings	MBAMateSettings	value

Returns: IMBA2_SDK_MatingPair

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

AddMBAPart

No description yet.

IMBA2_SDK_ArrayList AddMBAPart(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: IMBA2_SDK_ArrayList

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

AddPCBPart

No description yet.

IMBA2_SDK_Part AddPCBPart(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: IMBA2_SDK_Part

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

AddSTEPPart

No description yet.

IMBA2_SDK_Part AddSTEPPart(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: IMBA2_SDK_Part

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

CalculateMateSettings

No description yet.

MBAMateSettingsWithOrientation CalculateMateSettings(IMBA2_SDK_MatingItem argItemA, IMBA2_SDK_MatingItem argItemB);

Parameter	Type	Passing
argItemA	IMBA2_SDK_MatingItem	value
argItemB	IMBA2_SDK_MatingItem	value

Returns: MBAMateSettingsWithOrientation

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

ConvertLocalToWorldDirection

No description yet.

MBAVec3 ConvertLocalToWorldDirection(IMBA2_SDK_Part argPart, MBAVec3 argDirection);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value
argDirection	MBAVec3	value

Returns: MBAVec3

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

ConvertLocalToWorldPosition

No description yet.

MBAVec3 ConvertLocalToWorldPosition(IMBA2_SDK_Part argPart, MBAVec3 argPosition);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value
argPosition	MBAVec3	value

Returns: MBAVec3

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

ConvertWorldToLocalDirection

No description yet.

MBAVec3 ConvertWorldToLocalDirection(IMBA2_SDK_Part argPart, MBAVec3 argDirection);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value
argDirection	MBAVec3	value

Returns: MBAVec3

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

ConvertWorldToLocalPosition

No description yet.

MBAVec3 ConvertWorldToLocalPosition(IMBA2_SDK_Part argPart, MBAVec3 argPosition);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value
argPosition	MBAVec3	value

Returns: MBAVec3

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

Export3DStep

No description yet.

void Export3DStep(string argFileName, string argParams);

Parameter	Type	Passing
argFileName	string	value
argParams	string	value

Returns: nothing (void)

FindFaceByRay

No description yet.

IMBA2_SDK_Face FindFaceByRay(MBAVec3 argRayOrigin, MBAVec3 argRayDirection, double argRayRadius);

Parameter	Type	Passing
argRayOrigin	MBAVec3	value
argRayDirection	MBAVec3	value
argRayRadius	double	value

Returns: IMBA2_SDK_Face

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

FindFaceOfComponentByRay

No description yet.

IMBA2_SDK_Face FindFaceOfComponentByRay(IMBA2_SDK_Component argComponent, MBAVec3 argRayOrigin, MBAVec3 argRayDirection, double argRayRadius);

Parameter	Type	Passing
argComponent	IMBA2_SDK_Component	value
argRayOrigin	MBAVec3	value
argRayDirection	MBAVec3	value
argRayRadius	double	value

Returns: IMBA2_SDK_Face

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

FindFaceOfPartByRay

No description yet.

IMBA2_SDK_Face FindFaceOfPartByRay(IMBA2_SDK_Part argPart, MBAVec3 argRayOrigin, MBAVec3 argRayDirection, double argRayRadius);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value
argRayOrigin	MBAVec3	value
argRayDirection	MBAVec3	value
argRayRadius	double	value

Returns: IMBA2_SDK_Face

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

FindNearestMatingItemByRay

No description yet.

IMBA2_SDK_MatingItem FindNearestMatingItemByRay(MBAVec3 argRayOrigin, MBAVec3 argRayDirection, double argRayRadius);

Parameter	Type	Passing
argRayOrigin	MBAVec3	value
argRayDirection	MBAVec3	value
argRayRadius	double	value

Returns: IMBA2_SDK_MatingItem

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

FindNearestMatingItemOfComponentByRay

No description yet.

IMBA2_SDK_MatingItem FindNearestMatingItemOfComponentByRay(IMBA2_SDK_Component argComponent, MBAVec3 argRayOrigin, MBAVec3 argRayDirection, double argRayRadius);

Parameter	Type	Passing
argComponent	IMBA2_SDK_Component	value
argRayOrigin	MBAVec3	value
argRayDirection	MBAVec3	value
argRayRadius	double	value

Returns: IMBA2_SDK_MatingItem

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

FindNearestMatingItemOfFaceByRay

No description yet.

IMBA2_SDK_MatingItem FindNearestMatingItemOfFaceByRay(IMBA2_SDK_Face argFace, MBAVec3 argRayOrigin, MBAVec3 argRayDirection);

Parameter	Type	Passing
argFace	IMBA2_SDK_Face	value
argRayOrigin	MBAVec3	value
argRayDirection	MBAVec3	value

Returns: IMBA2_SDK_MatingItem

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

FindNearestMatingItemOfPartByRay

No description yet.

IMBA2_SDK_MatingItem FindNearestMatingItemOfPartByRay(IMBA2_SDK_Part argPart, MBAVec3 argRayOrigin, MBAVec3 argRayDirection, double argRayRadius);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value
argRayOrigin	MBAVec3	value
argRayDirection	MBAVec3	value
argRayRadius	double	value

Returns: IMBA2_SDK_MatingItem

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

GetDataModel

No description yet.

IMBA2_SDK_DataModel GetDataModel();

Returns: IMBA2_SDK_DataModel

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

GetPart

No description yet.

IMBA2_SDK_Part GetPart(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IMBA2_SDK_Part

Extension method of IMBA2_SDK_DocumentHelper (using EDP;).

GetPartCount

No description yet.

int GetPartCount();

Returns: int

GetSceneData

No description yet.

string GetSceneData();

Returns: string

MeasureDistanceComponentToComponent

No description yet.

double MeasureDistanceComponentToComponent(IMBA2_SDK_Component argComponentA, IMBA2_SDK_Component argComponentB);
double MeasureDistanceComponentToComponent(object argComponentA, object argComponentB);

Parameter	Type	Passing
argComponentA	IMBA2_SDK_Component	value
argComponentB	IMBA2_SDK_Component	value

Returns: double

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

MeasureDistanceComponentToFace

No description yet.

double MeasureDistanceComponentToFace(IMBA2_SDK_Component argComponent, IMBA2_SDK_Face argFace);
double MeasureDistanceComponentToFace(object argComponent, object argFace);

Parameter	Type	Passing
argComponent	IMBA2_SDK_Component	value
argFace	IMBA2_SDK_Face	value

Returns: double

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

MeasureDistanceFaceToFace

No description yet.

double MeasureDistanceFaceToFace(IMBA2_SDK_Face argFaceA, IMBA2_SDK_Face argFaceB);
double MeasureDistanceFaceToFace(object argFaceA, object argFaceB);

Parameter	Type	Passing
argFaceA	IMBA2_SDK_Face	value
argFaceB	IMBA2_SDK_Face	value

Returns: double

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

RemoveMate

No description yet.

bool RemoveMate(IMBA2_SDK_MatingPair argMate);
bool RemoveMate(object argMate);

Parameter	Type	Passing
argMate	IMBA2_SDK_MatingPair	value

Returns: bool

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

RemovePart

No description yet.

bool RemovePart(IMBA2_SDK_Part argPart);
bool RemovePart(object argPart);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value

Returns: bool

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

SetMateOrientation

No description yet.

void SetMateOrientation(IMBA2_SDK_MatingPair argMate, TMBAMateOrientation argMateOrientation);
void SetMateOrientation(object argMate, int argMateOrientation);

Parameter	Type	Passing
argMate	IMBA2_SDK_MatingPair	value
argMateOrientation	TMBAMateOrientation	value

Returns: nothing (void)

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

SetMateSettings

No description yet.

void SetMateSettings(IMBA2_SDK_MatingPair argMate, MBAMateSettings argSettings);
void SetMateSettings(object argMate, IMBAMateSettings argSettings);

Parameter	Type	Passing
argMate	IMBA2_SDK_MatingPair	value
argSettings	MBAMateSettings	value

Returns: nothing (void)

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

SetMateType

No description yet.

void SetMateType(IMBA2_SDK_MatingPair argMate, TMBAMateType argMateType);
void SetMateType(object argMate, int argMateType);

Parameter	Type	Passing
argMate	IMBA2_SDK_MatingPair	value
argMateType	TMBAMateType	value

Returns: nothing (void)

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

SetPartTransform

No description yet.

void SetPartTransform(IMBA2_SDK_Part argPart, MBAMat4 argTransform);
void SetPartTransform(object argPart, IMBAMat4 argTransform);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value
argTransform	MBAMat4	value

Returns: nothing (void)

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

SetPartTransform_ForPreview

No description yet.

void SetPartTransform_ForPreview(int argPartId, MBAMat4 argTransform);
void SetPartTransform_ForPreview(int argPartId, IMBAMat4 argTransform);

Parameter	Type	Passing
argPartId	int	value
argTransform	MBAMat4	value

Returns: nothing (void)

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

SetPartTransformByPartId

No description yet.

void SetPartTransformByPartId(int argPartId, MBAMat4 argTransform);
void SetPartTransformByPartId(int argPartId, IMBAMat4 argTransform);

Parameter	Type	Passing
argPartId	int	value
argTransform	MBAMat4	value

Returns: nothing (void)

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

UpdateAllParts

No description yet.

void UpdateAllParts();

Returns: nothing (void)

UpdatePart

No description yet.

void UpdatePart(IMBA2_SDK_Part argPart);
void UpdatePart(object argPart);

Parameter	Type	Passing
argPart	IMBA2_SDK_Part	value

Returns: nothing (void)

The first overload is an extension method of IMBA2_SDK_DocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.

Inherited members

• From IServerDocument: AcquireDataFileHandle, AcquireFileOwnership, AddView, BeingClosed, CanCreateSnippet, CanPlaceSnippet, CreateSnippetFile, DocumentDirectoryChanged, DoFileLoad, DoFileSave, DoSafeChangeFileNameAndSave, DoSafeFileSave, FileModifiedDate, FileName, Focus, GetCanClose, GetContextHelpTopicName, GetCount, GetDocumentModifiedDate, GetKind, GetServerModule, GetSnippetView, GetSupportsOwnSave, GetView, GetViewByName, IsShown, Modified, NotifyViews, OwnsFile, PlaceSnippet, ReleaseDataFileHandle, ReleaseFileOwnership, SupportsReload, UpdateModifiedDate, WarnIfOwnedByOther, ZoomSnippetContents

Returned by

IMBA2_SDK_CoreObject.GetDocument