IOccWrapper interface

No description yet.

public interface IOccWrapper

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddAssemblyToMainLabel	int
AddIgesModel	int
AddInstance	int
AddMetaCompound	int
AddModelToAssembly	int
AddStepModel	int
AddStepModelToAssembly	int
AddTrack	int
CloseDocument	int
CreateAssemblyQuery	int
CreateColour	int
CreateCylinderShape	int
CreateExtrudedShape	int
CreateGeomTool	int
CreateMetaCompound	int
CreateModelTriangulation	int
CreateOccDocument	int
CreateOutline	int
CreatePlanarPolygon	int
CreateShapeCollection	int
CreateShapeTool	int
CreateSphereShape	int
CreateSpline	ISpline
CreateTransformation	int
CreateTransformedExtrudedShape	int
ExportToStep	void
GenerateStepModelForCylinder	void
GenerateStepModelForExtruded	void
GenerateStepModelForSphere	void
IsAssembly	int
NewAssembly	int
NewDocument	int
Transfer	int

AddAssemblyToMainLabel

No description yet.

int AddAssemblyToMainLabel(int argssemblyIndex);

Parameter	Type	Passing
argssemblyIndex	int	value

Returns: int

AddIgesModel

No description yet.

int AddIgesModel(string argModelKey, string argIgesFilename, object argpTransformation, out int argpIndex);

Parameter	Type	Passing
argModelKey	string	value
argIgesFilename	string	value
argpTransformation	object	value
argpIndex	int	out

Returns: int

AddInstance

No description yet.

int AddInstance(int argParentShapeIndex, int argInstanceShapeIndex, object argpIPCB3D_Transformation, out bool argpSuccess);

Parameter	Type	Passing
argParentShapeIndex	int	value
argInstanceShapeIndex	int	value
argpIPCB3D_Transformation	object	value
argpSuccess	bool	out

Returns: int

AddMetaCompound

No description yet.

int AddMetaCompound(object argpIPCB3D_MetaCompound, object argpIPCB3D_Transformation, string argname, out int argpIndex);

Parameter	Type	Passing
argpIPCB3D_MetaCompound	object	value
argpIPCB3D_Transformation	object	value
argname	string	value
argpIndex	int	out

Returns: int

AddModelToAssembly

No description yet.

int AddModelToAssembly(int argssemblyShapeIndex, string argModelKey, string argModelFilename, object argpTransformation, object argpOverideColor, out int argpIndex);

Parameter	Type	Passing
argssemblyShapeIndex	int	value
argModelKey	string	value
argModelFilename	string	value
argpTransformation	object	value
argpOverideColor	object	value
argpIndex	int	out

Returns: int

AddStepModel

No description yet.

int AddStepModel(string argModelKey, string argStepFilename, object argpTransformation, out int argpIndex);

Parameter	Type	Passing
argModelKey	string	value
argStepFilename	string	value
argpTransformation	object	value
argpIndex	int	out

Returns: int

AddStepModelToAssembly

No description yet.

int AddStepModelToAssembly(int argssemblyShapeIndex, string argModelKey, string argStepFilename, object argpTransformation, out int argpIndex);

Parameter	Type	Passing
argssemblyShapeIndex	int	value
argModelKey	string	value
argStepFilename	string	value
argpTransformation	object	value
argpIndex	int	out

Returns: int

AddTrack

No description yet.

int AddTrack(double argx1, double argy1, double argx2, double argy2, double argw, double argh, double argzPosition, object argpColor, double argisLast);

Parameter	Type	Passing
argx1	double	value
argy1	double	value
argx2	double	value
argy2	double	value
argw	double	value
argh	double	value
argzPosition	double	value
argpColor	object	value
argisLast	double	value

Returns: int

CloseDocument

No description yet.

int CloseDocument();

Returns: int

CreateAssemblyQuery

No description yet.

int CreateAssemblyQuery(out object argpAssemblyQuery);

Parameter	Type	Passing
argpAssemblyQuery	object	out

Returns: int

CreateColour

No description yet.

int CreateColour(out object argpColour);

Parameter	Type	Passing
argpColour	object	out

Returns: int

CreateCylinderShape

No description yet.

int CreateCylinderShape(out object argpCylinderShape);

Parameter	Type	Passing
argpCylinderShape	object	out

Returns: int

CreateExtrudedShape

No description yet.

int CreateExtrudedShape(out object argpExtrudedShape);

Parameter	Type	Passing
argpExtrudedShape	object	out

Returns: int

CreateGeomTool

No description yet.

int CreateGeomTool(out IPCB3D_GeomTool argpGeomTool);

Parameter	Type	Passing
argpGeomTool	IPCB3D_GeomTool	out

Returns: int

CreateMetaCompound

No description yet.

int CreateMetaCompound(out object argpMetaCompound);

Parameter	Type	Passing
argpMetaCompound	object	out

Returns: int

CreateModelTriangulation

No description yet.

int CreateModelTriangulation(out object argpModelTriangulation);

Parameter	Type	Passing
argpModelTriangulation	object	out

Returns: int

CreateOccDocument

No description yet.

int CreateOccDocument(out IOCCDocument argpResultDocument);

Parameter	Type	Passing
argpResultDocument	IOCCDocument	out

Returns: int

CreateOutline

No description yet.

int CreateOutline(out object argpOutline);

Parameter	Type	Passing
argpOutline	object	out

Returns: int

CreatePlanarPolygon

No description yet.

int CreatePlanarPolygon(out object argpPlanarPolygon);

Parameter	Type	Passing
argpPlanarPolygon	object	out

Returns: int

CreateShapeCollection

No description yet.

int CreateShapeCollection(out object argpShapeCollection);

Parameter	Type	Passing
argpShapeCollection	object	out

Returns: int

CreateShapeTool

No description yet.

int CreateShapeTool(out IPCB3D_ShapeTool argpShapeTool);

Parameter	Type	Passing
argpShapeTool	IPCB3D_ShapeTool	out

Returns: int

CreateSphereShape

No description yet.

int CreateSphereShape(out object argpSphereShape);

Parameter	Type	Passing
argpSphereShape	object	out

Returns: int

CreateSpline

No description yet.

ISpline CreateSpline(int argdimension, bool argrational, int argdegree, IPointList argControlPoints, IDoubleList argweights, IDoubleList argKnots, ICardinalList argknot_multiplicity);

Parameter	Type	Passing
argdimension	int	value
argrational	bool	value
argdegree	int	value
argControlPoints	IPointList	value
argweights	IDoubleList	value
argKnots	IDoubleList	value
argknot_multiplicity	ICardinalList	value

Returns: ISpline

Extension method of IOccWrapperHelper (using PCB;).

CreateTransformation

No description yet.

int CreateTransformation(out object argpTransformation);

Parameter	Type	Passing
argpTransformation	object	out

Returns: int

CreateTransformedExtrudedShape

No description yet.

int CreateTransformedExtrudedShape(out object argpExtrudedShape);

Parameter	Type	Passing
argpExtrudedShape	object	out

Returns: int

ExportToStep

No description yet.

void ExportToStep(string argfilename);

Parameter	Type	Passing
argfilename	string	value

Returns: nothing (void)

GenerateStepModelForCylinder

No description yet.

void GenerateStepModelForCylinder(object argpCylinder, object argpTransformation, object argpColor, string argStepFilename);

Parameter	Type	Passing
argpCylinder	object	value
argpTransformation	object	value
argpColor	object	value
argStepFilename	string	value

Returns: nothing (void)

GenerateStepModelForExtruded

No description yet.

void GenerateStepModelForExtruded(object argpExtruded, object argpTransformation, object argpColor, string argStepFilename);

Parameter	Type	Passing
argpExtruded	object	value
argpTransformation	object	value
argpColor	object	value
argStepFilename	string	value

Returns: nothing (void)

GenerateStepModelForSphere

No description yet.

void GenerateStepModelForSphere(object argpSphere, object argpTransformation, object argpColor, string argStepFilename);

Parameter	Type	Passing
argpSphere	object	value
argpTransformation	object	value
argpColor	object	value
argStepFilename	string	value

Returns: nothing (void)

IsAssembly

No description yet.

int IsAssembly(int argShapeIndex, out bool argpSuccess);

Parameter	Type	Passing
argShapeIndex	int	value
argpSuccess	bool	out

Returns: int

NewAssembly

No description yet.

int NewAssembly(string argname, out int argpIndex);

Parameter	Type	Passing
argname	string	value
argpIndex	int	out

Returns: int

NewDocument

No description yet.

int NewDocument(bool argcreateTopLabel);

Parameter	Type	Passing
argcreateTopLabel	bool	value

Returns: int

Transfer

No description yet.

int Transfer(IOCCDocument argoccDocument);
int Transfer(object argoccDocument);

Parameter	Type	Passing
argoccDocument	IOCCDocument	value

Returns: int

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

Returned by

IPCB_ServerInterface.GetOccWrapper

Accepted by

IPCB_Model.AddTo, IPCB_Model.AddToAssembly, IPCB_Model.AddToAssembly2