wizoscriptreference - pcloud - file security made simple ... design/wizoscri… ·...

WizoScript Reference


Information in this document is subject to change without notice and does not representa commitment on the part of the manufacturer. The software described in this documentis furnished under license agreement or nondisclosure agreement and may be used orcopied in accordance with the terms of the agreement. It is against the law to copy thesoftware on any medium except as specifically allowed in the license or nondisclosureagreement. No part of this manual may be reproduced or transmitted in any form or byany means, electronic or mechanical, including photocopying, recording, or informationstorage and retrieval systems, for any purpose other than the software purchaser’s use,without prior written permission.

Every effort was made to ensure the accuracy in this manual and to give appropriatecredit to persons, companies and trademarks referenced herein.

© Britishideas 2013-2018, All Rights Reserved

Microsoft® and Windows™ are trademarks or registered trademarks of MicrosoftCorporation.PC® is a registered trademark of International Business Machines Corporation.


Class: AssemblyAn assembly

PropertiesConfigurationsType: Python listA list of configurations defined on the assembly (read-only)

FileNameType: stringPath and filename of the assembly

NameType: stringName of the assembly (read only)

OriginType: PointGets the origin (language independent)

ParametersType: Python listA list of parameters defined on the assembly (read-only)

PartsType: Python listA list of parts defined on the assembly (read-only)

SubAssembliesType: Python listA list of subassemblies defined on the assembly (read-only)

XAxisType: AxisGets the X-axis (language independent)

XYPlaneType: PlaneGets the XY-plane (language independent)

YAxisType: AxisGets the Y-axis (language independent)

YZPlaneType: PlaneGets the YZ-plane (language independent)


ZAxisType: AxisGets the Z-axis (language independent)

ZXPlaneType: PlaneGets the ZX-plane (language independent)

FunctionsAddAlignConstraintAdds an alignment constraint between two planes/faces/axes/edges/points.:

AddAlignConstraint(double Distance, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB, bool IsReversed, string Name)

Adds an alignment constraint between two planes/faces/axes/edges/points.:

AddAlignConstraint(double Distance, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB)

AddAngleConstraintAdds an angle constraint between two planes/faces/axes/edges/points.:

AddAngleConstraint(double Angle, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB)

Adds an angle constraint between two planes/faces/axes/edges/points.:

AddAngleConstraint(double Angle, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB, bool IsReversed, string Name)

AddAxisAdds a design axis based on two points. Points are defined as lists of [x, y, z].:

Axis AddAxis(string Name, List Point1, List Point2)

Adds a design axis based on the intersection of two planes or faces:

Axis AddAxis(string Name, ExistingPlaneorFace1, ExistingPlaneorFace2)

AddConfigurationCreates a configuration:


Configuration AddConfiguration(string Name)

Creates a configuration using another configuration as a base:

Configuration AddConfiguration(string Name, string BaseConfigurationName)

AddMateConstraintAdds a mate constraint between two planes/faces/axes/edges/points.:

AddMateConstraint(double Distance, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB, bool IsReversed, string Name)

Adds a mate constraint between two planes/faces/axes/edges/points.:

AddMateConstraint(double Distance, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlacFaceAxisEdgePoint ItemB)

AddNewPartAdds a new part to an assembly.:

AssembledPart AddNewPart(string Name, double X, double Y, double Z)

AddNewSubAssemblyAdds a new sub-assembly to an assembly.:

AssembledSubAssembly AddNewSubAssembly(string Name, double X, double Y,double Z)

AddOrientConstraintAdds an orient constraint between two planes/faces/axes/edges/points.:

AddOrientConstraint(double Value, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB)

Adds an orient constraint between two planes/faces/axes/edges/points.:

AddOrientConstraint(double Value, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB, bool IsReversed, string Name)

AddParameterCreates a parameter with a value:

Parameter AddParameter(string Name, Type, double Value)


Creates a parameter with an equation:

Parameter AddParameter(string Name, Type, string Equation)

AddPartAdds a part to an assembly at the origin. Omit AD_PRT from the name:

AssembledPart AddPart(string Folder, string Name)

Adds a part to an assembly at the origin.:

AssembledPart AddPart(Part)

Adds a part to an assembly. Omit AD_PRT from the name:

AssembledPart AddPart(string Folder, string Name, double OffsetX, doubleOffsetY, double OffsetZ)

Adds a part to an assembly. Omit AD_PRT from the name:

AssembledPart AddPart(string Folder, string Name, double OffsetX, doubleOffsetY, double OffsetZ, double AngleX, double AngleY, double AngleZ, boolTranslationFirst)

Adds a part to an assembly.:

AssembledPart AddPart(string FileName, double OffsetX, double OffsetY,double OffsetZ, double AngleX, double AngleY, double AngleZ, boolTranslationFirst)


AssembledPart AddPart(Part, double OffsetX, double OffsetY, double OffsetZ,double AngleX, double AngleY, double AngleZ, bool TranslationFirst)


AssembledPart AddPart(string FileName, double OffsetX, double OffsetY,double OffsetZ)


AssembledPart AddPart(Part, double OffsetX, double OffsetY, double OffsetZ)

Adds a part to an assembly at the origin.:

AssembledPart AddPart(string FileName)


AddPlaneCreates a design plane using an offset from an existing plane or face:

Plane AddPlane(string Name, ExistingPlaneorFace, double Offset)

Creates a new design plane at an angle to an existing plane or face:

Plane AddPlane(string Name, ExistingPlaneorFace, Axis RotationAxis, doubleAngle)

Creates a design plane using a normal vector [nx, ny, nz] and a point on the plane [px,py, pz]:

Plane AddPlane(string Name, List Normal Vector, List PointonPlane)

Creates a design plane using three points. Each point is defined as list of [x, y, z].:

Plane AddPlane(string Name, List Point1, List Point2, List Point3)

AddPointAdds a design point:

Point AddPoint(string Name, double X, double Y, double Z)

AddPointsAdds a set of design points. Points are defined as [x1,y1,z1, ..., xn,yn,zn]:

AddPoints(string Prefix, List Points)

AddSubAssemblyAdds a sub-assembly to an assembly.:

AssembledSubAssembly AddSubAssembly(Assembly, double OffsetX, doubleOffsetY, double OffsetZ)

Adds a sub-assembly to an assembly at the origin.:

AssembledSubAssembly AddSubAssembly(string FileName)

Adds a sub-assembly to an assembly at the origin.:

AssembledSubAssembly AddSubAssembly(Assembly)

Adds a sub-assembly to an assembly. Omit AD_ASM from the name:

AssembledSubAssembly AddSubAssembly(string Folder, string Name, doubleOffsetX, double OffsetY, double OffsetZ, double AngleX, double AngleY,double AngleZ, bool TranslationFirst)


Adds a sub-assembly to an assembly.:

AssembledSubAssembly AddSubAssembly(string FileName, double OffsetX, doubleOffsetY, double OffsetZ)


AssembledSubAssembly AddSubAssembly(Assembly, double OffsetX, doubleOffsetY, double OffsetZ, double AngleX, double AngleY, double AngleZ, boolTranslationFirst)

Adds a sub-assembly to an assembly at the origin. Omit AD_ASM from the name:

AssembledSubAssembly AddSubAssembly(string Folder, string Name)

Adds a sub-assembly to an assembly. Omit AD_ASM from the name:

AssembledSubAssembly AddSubAssembly(string Folder, string Name, doubleOffsetX, double OffsetY, double OffsetZ)


AssembledSubAssembly AddSubAssembly(string FileName, double OffsetX, doubleOffsetY, double OffsetZ, double AngleX, double AngleY, double AngleZ, boolTranslationFirst)

AddTangentConstraintAdds a tangent constraint between two planes/faces/axes/edges/points.:

AddTangentConstraint(double Distance, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB, bool Outside, bool IsReversed, string Name)

Adds a tangent constraint between two planes/faces/axes/edges/points.:

AddTangentConstraint(double Distance, AssembledPartOrSubAssemblyA,PlaneFaceAxisEdgePoint ItemA, AssembledPartOrSubAssemblyB,PlaneFaceAxisEdgePoint ItemB, bool Outside)

AnchorPartAnchors a part in an assembly.:

AnchorPart(AssembledPart)

Anchors a part in an assembly.:

AnchorPart(string Name)


AnchorSubAssemblyAnchors a sub-assembly in an assembly.:

AnchorSubAssembly(string Name)

AssemblyOpens an existing assembly for editing. Omit AD_ASM from the name:

obj = Assembly(string Folder, string Name)

Creates a new assembly:

obj = Assembly(string Name)

Creates a new assembly or accesses an already opened assembly. Set CreateNew toTrue to create a new assembly.:

obj = Assembly(string Name, bool CreateNew)

CloseCloses the assembly. If it is unsaved then changes will be lost:

Close()

CreateUniqueNameCreates a unique name that can be used to safely add a part or subassembly to theassembly if the names used in the assembly are not known in advance.:

string CreateUniqueName(string BaseName)

DuplicatePartDuplicates a part in an assembly.:

AssembledPart DuplicatePart(AssembledPart, double OffsetX, double OffsetY,double OffsetZ)

Duplicates a part in an assembly.:

AssembledPart DuplicatePart(string Name, double OffsetX, double OffsetY,double OffsetZ)


AssembledPart DuplicatePart(AssembledPart, double OffsetX, double OffsetY,double OffsetZ, double AngleX, double AngleY, double AngleZ, boolTranslationFirst)



AssembledPart DuplicatePart(string Name, double OffsetX, double OffsetY,double OffsetZ, double AngleX, double AngleY, double AngleZ, boolTranslationFirst)

DuplicateSubAssemblyDuplicates a sub-assembly in an assembly.:

AssembledSubAssembly DuplicateSubAssembly(AssembledSubAssembly, doubleOffsetX, double OffsetY, double OffsetZ)

Duplicates a sub-assembly in an assembly.:

AssembledSubAssembly DuplicateSubAssembly(AssembledSubAssembly, doubleOffsetX, double OffsetY, double OffsetZ, double AngleX, double AngleY,double AngleZ, bool TranslationFirst)


AssembledSubAssembly DuplicateSubAssembly(string Name, double OffsetX,double OffsetY, double OffsetZ, double AngleX, double AngleY, doubleAngleZ, bool TranslationFirst)


AssembledSubAssembly DuplicateSubAssembly(string Name, double OffsetX,double OffsetY, double OffsetZ)

GetActiveConfigurationGets the currently active configuration:

Configuration GetActiveConfiguration()

GetAxisGets an axis on the assembly using the axis name. The axis must have been created in ascript:

Axis GetAxis(string Name)

GetConfigurationGets a configuration on the assembly using the configuration name:

Configuration GetConfiguration(string Name)

GetParameterGets a parameter on the assembly using the parameter name:


Parameter GetParameter(string Name)

GetPartGets a part instance from an assembly.:

AssembledPart GetPart(string Name)

GetPlaneGets a plane on the assembly using the name of the plane. The plane must have beencreated in a script:

Plane GetPlane(string Name)

GetPointGets a point on the assembly using the point name. The point must have been created ina script:

Point GetPoint(string Name)

GetSubAssemblyGets a sub-assembly instance from an assembly.:

AssembledSubAssembly GetSubAssembly(string Name)

HidePartHide a part in an assembly.:

HidePart(AssembledPart)

Hide a part in an assembly.:

HidePart(string Name)

HideSubAssemblyHide a sub-assembly in an assembly.:

HideSubAssembly(string Name)

MovePartMoves a part.:

MovePart(AssembledPart, double OffsetX, double OffsetY, double OffsetZ)

Moves a part.:

MovePart(string Name, double OffsetX, double OffsetY, double OffsetZ)


MovePartsMoves a set of parts.:

MoveParts(List Names, double OffsetX, double OffsetY, double OffsetZ)

MoveSubAssembliesMoves a set of sub-assemblies.:

MoveSubAssemblies(List Names, double OffsetX, double OffsetY, doubleOffsetZ)

MoveSubAssemblyMoves a sub-assembly.:

MoveSubAssembly(string Name, double OffsetX, double OffsetY, doubleOffsetZ)

Moves a sub-assembly.:

MoveSubAssembly(AssembledSubAssembly, double OffsetX, double OffsetY,double OffsetZ)

RegenerateRegenerates the assembly:

Regenerate()

Regenerates the assembly:

Regenerate()

RotatePartRotates a part.:

RotatePart(string Name, double AngleX, double AngleY, double AngleZ)

Rotates a part.:

RotatePart(AssembledPart, double AngleX, double AngleY, double AngleZ)

RotatePartsRotates a set of parts.:

RotateParts(List Names, double AngleX, double AngleY, double AngleZ)

RotateSubAssembliesRotates a set of sub-assemblies.:


RotateSubAssemblies(List Names, double AngleX, double AngleY, doubleAngleZ)

RotateSubAssemblyRotates a sub-assembly.:

RotateSubAssembly(AssembledSubAssembly, double AngleX, double AngleY,double AngleZ)

Rotates a sub-assembly.:

RotateSubAssembly(string Name, double AngleX, double AngleY, double AngleZ)

SaveSaves the assembly into a specific folder using the current name:

Save(string Folder)

Saves the assembly using the current path and file name:

Save()

SaveAllSaves the assembly and all parts/sub-assemblies into a folder:

SaveAll(string Folder)

SaveAsSaves the assembly into a specific folder with a new name:

SaveAs(string Folder, string NewName)

SaveSnapshotSaves the current view as a bitmap image:

SaveSnapshot(string FileName, int Width, int Height, bool UseAspectRatio,bool UseWidthandHeight)

SaveThumbnailSaves a thumbnail image of the assembly:

SaveThumbnail(string FileName, int Width, int Height)

ShowPartShows a part in an assembly.:

ShowPart(AssembledPart)


Shows a part in an assembly.:

ShowPart(string Name)

ShowSubAssemblyShows a sub-assembly in an assembly.:

ShowSubAssembly(string Name)

SuppressPartSuppresses a part in an assembly.:

SuppressPart(AssembledPart)

Suppresses a part in an assembly.:

SuppressPart(string Name)

SuppressSubAssemblySuppresses a sub-assembly in an assembly.:

SuppressSubAssembly(string Name)

UnanchorPartUn-anchors a part in an assembly.:

UnanchorPart(AssembledPart)

Un-anchors a part in an assembly.:

UnanchorPart(string Name)

UnanchorSubAssemblyUn-anchors a sub-assembly in an assembly.:

UnanchorSubAssembly(string Name)

UnsuppressPartUn-suppresses a part in an assembly.:

UnsuppressPart(AssembledPart)

Un-suppresses a part in an assembly.:

UnsuppressPart(string Name)


UnsuppressSubAssemblyUn-suppresses a sub-assembly in an assembly.:

UnsuppressSubAssembly(string Name)


Class: AxisDescribes an axis

PropertiesNameType: stringThe name of the axis (read only)

FunctionsGetPartGets the part that the axis is defined on:

GetPart()

GetSelectionAssemblyGets the assembly that the edge was selected on. Only valid if edge was selected byuser:

Assembly GetSelectionAssembly()


Class: BsplineDefines a Bspline that can be added to 2D sketches

PropertiesIsReferenceType: boolTrue if the bspline is a reference bspline, false if it is a regular bspline

KnotVectorsType: Python listThe knot vectors [k1, k2, ..., kn]

OrderType: intThe order of the bspline

PointsType: Python listThe control points [x1, y1, ..., xn, yn]

WeightsType: Python listThe weights [w1, w2, ..., wn]

FunctionsBsplineCreates a bspline for adding to 2D sketches:

obj = Bspline(int Order, [Point1X, Point1Y, ...], [KnotVector1,KnotVector2, ...], [Weight1, Weight2, ...], bool IsReference)


Class: CircleDescribes a 2D circle, which can be added to 2D sketches

PropertiesCenterType: Python listThe center of the circle [x, y]

IsReferenceType: boolTrue if the circle is a reference circle, false if it is a regular circle

LengthType: doubleThe length of the circle circumference in script units

RadiusType: doubleRadius of circle

FunctionsCircleCreates a 2D circle which can be added to sketches:

obj = Circle([CenterX, CenterY], double Radius, bool IsReference)


Class: CircularArcDescribes a 2D circular arc, which can be added to 2D sketches

EnumerationsArcTypeType of circular arc

• CenterStartEnd• CenterStartAngle

PropertiesAngleType: doubleAngle of arc

CenterType: Python listThe center of the arc [x, y]

EndPointType: Python listThe end point of the arc [x, y]

IsReferenceType: boolTrue if the arc is a reference arc, false if it is a regular arc

RadiusType: doubleRadius of arc

StartPointType: Python listThe start point of the arc [x, y]

TypeType: ArcTypeType of arc (read-only)

FunctionsCircularArcCreates an arc using the center, start point and angle:


obj = CircularArc([CenterX, CenterY], [StartX, StartY], double Angle, boolIsReference)

Creates an arc using the center, start point and end point:

obj = CircularArc([CenterX, CenterY], [StartX, StartY], [EndX, EndY], boolIsReference)


Class: ConfigurationDescribes a configuration

PropertiesIsActiveType: boolTrue if the configuration is currently active (read-only)

NameType: stringThe name of the configuration (read-only)

FunctionsActivateMakes the configuration active:

Activate()

LockAllApplies all locks to the configuration:

LockAll()

SetLocksSets the locks on the configuration:

SetLocks(LockTypes Locks)

UnlockAllRemoves all locks from the configuration:

UnlockAll()


Class: EdgeDescribes an edge (can be filleted, chamfered, swept)

PropertiesDiameterType: doubleDiameter of the edge, if it is a circle (read only)

NameType: stringName of the edge (read only)

FunctionsGetPartGets the part that the edge is defined on:

GetPart()




Class: FaceDescribes a face (can be filleted, chamfered, used for sketches, used for loft crosssections)

PropertiesNameType: stringThe name of the face

FunctionsDistanceToGets the distance from this face to another face. Faces must be parallel:

double DistanceTo(Face OtherFace)

GetPartGets the part that the face is defined on:

GetPart()



IsParallelChecks if another face is parallel to this one:

bool IsParallel(Face OtherFace)


Class: FeatureDescribes a feature of an object, e.g. boss, cut

PropertiesNameType: stringName of the feature (read only)


Class: GearSketchA sketch containing an involute gear profile. Can be treated as a regular sketch.

PropertiesCenterXType: doubleX coordinate of gear center

CenterYType: doubleY coordinate of gear center

DiametralPitchType: doubleDiametral pitch of gear in teeth per inch

NumberofTeethType: intNumber of teeth in gear

PitchDiameterType: doublePitch diameter of gear in script units

PressureAngleType: doublePressure angle of gear


Class: GlobalParametersA set of global parameters

PropertiesConfigurationsType: Python listA list of configurations (read-only)

NameType: stringName of the global parameters (read only)

ParametersType: Python listA list of parameters (read-only)

FunctionsAddConfigurationCreates a configuration using another configuration as a base:


Creates a configuration:


AddParameterCreates a parameter with an equation:

Parameter AddParameter(string Name, Type, string Equation)

Creates a parameter with a value:

Parameter AddParameter(string Name, Type, double Value)

CloseCloses the global parameters set. If it is unsaved then changes will be lost:

Close()




GetConfigurationGets a configuration using the configuration name:


GetParameterGets a parameter using the parameter name:


GlobalParametersOpens an existing global parameters set for editing. Omit AD_GLP from the name:

obj = GlobalParameters(string Folder, string Name)

Creates a new global parameters set:

obj = GlobalParameters(string Name)

Creates a new global parameters set or accesses an already opened global parametersset. Set CreateNew to True to create a new set.:

obj = GlobalParameters(string Name, bool CreateNew)

SaveSaves the global parameters set using the current path and file name:

Save()

Saves the global parameters set into a specific folder using the current name:

Save(string Folder)

SaveAsSaves the global parameters set into a specific folder with a new name:



Enumeration: GuideCurveTypesType of guide curve

• Global• Local• Tangent


Class: LineDescribes a 2D line, which can be added to 2D sketches

PropertiesEndPointType: Python listThe end point of the line [x, y]

IsReferenceType: boolTrue if the line is a reference line, false if it is a regular line

LengthType: doubleThe length of the line in script units

StartPointType: Python listThe start point of the line [x, y]

FunctionsLineCreates a 2D line which can be added to sketches:

obj = Line([StartPointX, StartPointY], [EndPointX, EndPointY], boolIsReference)


Enumeration: LockTypesType of configuration lock

• None• HideNewAnnotations• HideNewDesignGeometry• HideNewInclusions• HideNewSketches• LockActiveSectionView• LockColorProperties• LockComponentConfig• LockParameterValues• LockPropertyValues• SuppressNewComponents• SuppressNewConstraints• SuppressNewFeatures


Class: MaterialDefines material densities in kg/cm3

PropertiesABSType: doubleDensity for ABS plastic in kg/cm3

PLAType: doubleDensity for PLA plastic in kg/cm3


Class: ParameterDescribes a parameter (equation)

PropertiesCommentType: stringThe comment for the parameter

EquationType: stringThe equation of the parameter (write-only)

ExcelCellType: stringThe Excel cell associated with the parameter, e.g. '$B$3' (read-only)

ExcelSheetType: stringThe Excel sheet associated with the parameter, e.g. 'Sheet1' (read-only)

ExcelWorkbookType: stringThe Excel workbook associated with the parameter e.g. 'Foo.xlsx' (read-only)

NameType: stringThe name of the parameter

RawValueType: doubleThe raw value of the parameter

TypeType: ParameterTypesThe type of the parameter (read-only)

UnitsType: ParameterUnitsThe current units of the parameter

ValueType: doubleThe current value of the parameter in script units (for mm, cm, in), or degrees forangles, or raw value for other units

Functions


AttachToExcelAttaches the parameter to a cell in an Ezcel spreadsheet. Only supports distances inmm/cm/inches:

AttachToExcel(string Document, string Sheet, string Cell, ParameterTypesUnits)


Enumeration: ParameterTypesType of parameter

• Distance• Angle• Count• Scale


Enumeration: ParameterUnitsUnits of of parameter

• Unitless• Millimeters• Centimeters• Meters• Inches• Feet• FeetInches• Degrees• DegreesMinutes• DegreesMinutesSeconds• Radians• Kilograms• Grams• Pounds


Class: PartDescribes a part (single object)

EnumerationsDirectionTypeExtrusion directions - extrude along...

• Axis• Edge• Normal

EndConditionExtrusion end conditions - extrude until...

• ToDepth• MidPlane• ToNext• ToGeometry• EntirePath• ThroughAll

FileTypesSupported file types

• GeomagicDesignPart• STEP• IGES• ThreeDM• SAT• STL_in• STL_cm• STL_mm

PropertiesConfigurationsType: Python listA list of configurations defined on the part (read-only)

DescriptionType: stringDescription of the part

FileNameType: stringPath and filename of the part


MassType: doubleThe mass of the part in kg (read only)

MaterialType: doubleThe material used for the part - see Materials class

NameType: stringName of the part (read only)

NumberType: stringUser-defined number for the part



ParametersType: Python listA list of parameters defined on the part (read-only)

XAxisType: AxisGets the X-axis (language independent)

XYPlaneType: PlaneGets the XY-plane (language independent)



YZPlaneType: PlaneGets the YZ-plane (language independent)




ZXPlaneType: PlaneGets the ZX-plane (language independent)

FunctionsAdd3DSketchCreates a new 3D sketch:

Sketch3D Add3DSketch(string Name)

AddAxisAdds a design axis based on the intersection of two planes or faces:

Axis AddAxis(string Name, ExistingPlaneorFace1, ExistingPlaneorFace2)

Adds a design axis based on two points. Points are defined as lists of [x, y, z].:

Axis AddAxis(string Name, List Point1, List Point2)

AddChamferAdds a chamfer to a list of faces and edges:

Feature AddChamfer(string Name, ListofFacesandEdges, double Distance1,double Distance2, bool TangentPropagate)

Adds a chamfer to a face or edge:

Feature AddChamfer(string Name, FaceorEdge, double Distance, boolTangentPropagate)

Adds a chamfer to a face or edge:

Feature AddChamfer(string Name, FaceorEdge, double Distance1, doubleDistance2, bool TangentPropagate)

Adds a chamfer to a set of faces and edges:

Feature AddChamfer(string Name, ListofEdgesandFaces, double Distance, boolTangentPropagate)

AddChamferAngleAdds a chamfer to a set of faces and edges using distance and angle:


Feature AddChamferAngle(string Name, ListofEdgesandFaces, double Distance,double Angle, bool TangentPropagate)

Adds a chamfer to a face or edge using distance and angle:

Feature AddChamferAngle(string Name, EdgeorFace, double Distance, doubleAngle, bool TangentPropagate)

AddConfigurationCreates a configuration:


Creates a configuration using another configuration as a base:


AddExtrudeBossAdds an extrude boss based on a sketch:

Sketch AddExtrudeBoss(string Name, Sketch SketchtoUse, double Depth, boolIsReversed, EndCondition End, ExistingPlaneorFaceforEnd, double EndOffset,DirectionType Direction, SketchorEdgeforSweep, doubleDraftAngle, boolOutwardDraft)

Adds an extrude boss based on a sketch:

Feature AddExtrudeBoss(string Name, Sketch SketchtoUse, double Depth, boolIsReversed)

AddExtrudeCutAdds an extrude cut based on a sketch:

Sketch AddExtrudeCut(string Name, Sketch SketchtoUse, double Depth, boolIsReversed, EndCondition End, ExistingPlaneorFaceforEnd, double EndOffset,DirectionType Direction, SketchorEdgeforSweep, doubleDraftAngle, boolOutwardDraft)

Adds an extrude cut based on a sketch:

Feature AddExtrudeCut(string Name, Sketch SketchtoUse, double Depth, boolIsReversed

AddFilletAdds a constant radius fillet to a list of faces and edges:

Feature AddFillet(string Name, ListofFacesandEdges, double Radius, boolTangentPropagate)


Adds a constant radius fillet to a face or edge:

Feature AddFillet(string Name, ExistingFaceorEdge, double Radius, boolTangentPropagate)

Adds a variable radius fillet to a list of faces and edges:

Feature AddFillet(string Name, ListofFacesandEdges, ListofStartRadii,ListofEndRadii, bool TangentPropagate)

AddGearAdds a sketch containing an involute gear outline. Diametral pitch is in teeth per inch.Pitch diameter is in current script units.:

GearSketch AddGear(string Name, double DiametralPitch, int NumberofTeeth,double PitchDiameter, double PressureAngle, bool CreateSingleTooth, doubleCenterX, double CenterY, int InvolutePoints, ExistingPlaneorFace)

AddGearDNAdds a sketch to the part containing a gear defined by diametral pitch (teeth per inch)and number of teeth, optionally generates a single tooth:

GearSketch AddGearDN(string Name, double DiametralPitch, int NumberofTeeth,double PressureAngle, double CenterX, double CenterY, bool SingleTooth,ExistingPlaneorFace)

Adds a sketch to the part containing a gear defined by diametral pitch (teeth per inch)and number of teeth:

GearSketch AddGearDN(string Name, double DiametralPitch, int NumberofTeeth,double PressureAngle, double CenterX, double CenterY, ExistingPlaneorFace)

AddGearDPAdds a sketch to the part containing a gear defined by diametral pitch (teeth per inch)and pitch diameter (script units):

GearSketch AddGearDP(string Name, double DiametralPitch, doublePitchDiameter, double PressureAngle, double CenterX, double CenterY,ExistingPlaneorFace)

Adds a sketch to the part containing a gear defined by diametral pitch (teeth per inch)and pitch diameter (script units), optionally generates a single tooth:

GearSketch AddGearDP(string Name, double DiametralPitch, doublePitchDiameter, double PressureAngle, double CenterX, double CenterY, boolSingleTooth, ExistingPlaneorFace)

AddGearNP


Adds a sketch to the part containing a gear defined by number of teeth and pitchdiameter:

GearSketch AddGearNP(string Name, int NumberofTeeth, double PitchDiameter,double PressureAngle, double CenterX, double CenterY, ExistingPlaneorFace)

Adds a sketch to the part containing a gear defined by number of teeth and pitchdiameter, optionally generates a single tooth:

GearSketch AddGearNP(string Name, int NumberofTeeth, double PitchDiameter,double PressureAngle, double CenterX, double CenterY, bool SingleTooth,ExistingPlaneorFace)

AddLoftBossAdds a loft boss:

Feature AddLoftBoss(string Name, List CrossSections (points, faces, 2Dsketches), bool MinimizeTwist, bool MinimizeCurvature, boolSimplifySurface, bool ConnectEnds)

Adds a loft boss using guide curves:

Feature AddLoftBoss(string Name, List CrossSections (points, faces, 2Dsketches), List GuideCurves (3D sketches), GuideCurveType Type, boolMinimizeTwist, bool MinimizeCurvature, bool SimplifySurface, boolConnectEnds)

AddLoftCutAdds a loft cut using guide curves:

Feature AddLoftCut(string Name, List CrossSections (points, faces, 2Dsketches), List GuideCurves (3D sketches), GuideCurveType Type, boolMinimizeTwist, bool MinimizeCurvature, bool SimplifySurface, boolConnectEnds)

Adds a loft cut:

Feature AddLoftCut(string Name, List CrossSections (points, faces, 2Dsketches), bool MinimizeTwist, bool MinimizeCurvature, boolSimplifySurface, bool ConnectEnds)

AddParameterCreates a parameter with specific units:

Parameter AddParameter(string Name, ParameterTypes Type, ParameterTypesUnits, double Value)

Creates a cm/mm/in/deg parameter with a value:


Parameter AddParameter(string Name, ParameterTypes Type, double Value)

Creates a parameter with an equation:

Parameter AddParameter(string Name, ParameterTypes Type, string Equation)

AddPlaneCreates a design plane using three points. Each point is defined as list of [x, y, z].:

Plane AddPlane(string Name, List Point1, List Point2, List Point3)

Creates a new design plane at an angle to an existing plane or face:

Plane AddPlane(string Name, ExistingPlaneorFace, Axis RotationAxis, doubleAngle)

Creates a design plane using an offset from an existing plane or face:

Plane AddPlane(string Name, ExistingPlaneorFace, double Offset)

Creates a design plane using a normal vector [nx, ny, nz] and a point on the plane [px,py, pz]:

Plane AddPlane(string Name, List Normal Vector, List PointonPlane)

AddPointAdds a design point:

Point AddPoint(string Name, double X, double Y, double Z)

AddPointsAdds a set of design points. Points are defined as [x1,y1,z1, ..., xn,yn,zn]:

AddPoints(string Prefix, List Points)

AddRevolveBossAdds a revolve boss based on a sketch:

Feature AddRevolveBoss(string Name, Sketch SketchtoUse, AxisAxistoRevolveAround, double Angle)

AddRevolveCutAdds a revolve cut based on a sketch:

Feature AddRevolveCut(string Name, Sketch SketchtoUse, AxisAxistoRevolveAround, double Angle)


AddSketchCreates a new sketch on a plane or face:

Sketch AddSketch(string Name, ExistingPlaneorFace)

AddSweepBossAdds a sweep boss based on a sketch and sweep path:

Feature AddSweepBoss(string Name, Sketch SketchtoUse,EdgeorSketchtoSweepAlong, bool IsRigid, EndCondition End,ExistingPlaneorFaceforEnd, double EndOffset, double DraftAngle, boolOutwardDraft)

AddSweepCutAdds a sweep cut based on a sketch and sweep path:

Feature AddSweepCut(string Name, Sketch SketchtoUse,EdgeorSketchtoSweepAlong, bool IsRigid, EndCondition End,ExistingPlaneorFaceforEnd, double EndOffset, double DraftAngle, boolOutwardDraft)

AddVertexChamferAdds a chamfer to a vertex:

Feature AddVertexChamfer(string Name, Vertex, double Distance1, doubleDistance2, double Distance3)

Adds a chamfer to a set of vertices:

Feature AddVertexChamfer(string Name, ListofVertices, double Distance1,double Distance2, double Distance3)

CloseCloses the part. If it is unsaved then changes will be lost:

Close()

ExportSTEP203Exports the part as a STEP 203 file:

ExportSTEP203(string FileName)

ExportSTEP214Exports the part as a STEP 214 file:

ExportSTEP214(string FileName)

ExportSTLExports the part as an STL file using the default STL settings:


ExportSTL(string FileName)

Get3DSketchGets a 3D sketch on the part using the name of the sketch.:

Sketch3D Get3DSketch(string Name)



GetAxisGets an axis on the part using the axis name. The axis must have been created in ascript:

Axis GetAxis(string Name)

GetBoundingBoxGets the bounding box for the part as eight points as [P1, P2, ... P8]. Each point is [X, Y,Z]:

List GetBoundingBox()

GetConfigurationGets a configuration on the part using the configuration name:


GetEdgeGets an edge on the part using it's name 'Edge<n>':

Edge GetEdge(string Name)

GetEdgesGets a list of edges in the part:

List GetEdges()

GetFaceGets a face on the part using the name of the face 'Face<n>':

Face GetFace(string Name)

GetFacesGets a list of faces in the part:


List GetFaces()

Gets a list of faces in the part:

List GetFaces()

GetParameterGets a parameter on the part using the parameter name:


GetPlaneGets a plane on the part using the name of the plane. The plane must have been createdin a script:

Plane GetPlane(string Name)

GetPointGets a point on the part using the point name. The point must have been created in ascript:

Point GetPoint(string Name)

GetSketchGets a sketch on the part using the name of the sketch.:

Sketch GetSketch(string Name)

GetVertexGets a vertex on the part using the vertex name 'Vertex<n>':

Vertex GetVertex(string Name)

GetVerticesGets a list of vertices in the part:

List GetVertices()

HideFeatureHides a feature on the part:

HideFeature(Feature)

Hides a feature on the part:

HideFeature(string Name)


IsOpenChecks if the part is opened:

IsVisible()

NonUniformScaleNon-uniform scaling of the part:

Feature NonUniformScale(string Name, bool AboutCenter, double ScaleFactorX,double ScaleFactorY, double ScaleFactorZ)

PartCreates a new part or accesses an already opened part. Set CreateNew to True to createa new part.:

obj = Part(string Name, bool CreateNew)

Opens or imports an existing file for editing.:

obj = Part(string FileName, FileTypes Type)

Creates a new part or accesses an already opened part. Set CreateNew to True to createa new part.:

obj = Part(string Name, bool CreateNew)

Creates a new part:

obj = Part(string Name)

Opens an existing part for editing. Omit AD_PRT from the name:

obj = Part(string Folder, string Name)

RegenerateRegenerates the part:

Regenerate()

RemoveFeatureRemoves a feature from the part:

RemoveFeature(string Name)

Removes a feature from the part:

RemoveFeature(Feature)


RemoveSketchRemoves a sketch from the part:

RemoveSketch(string Name)

Removes a sketch from the part:

RemoveSketch(Sketch)

SaveSaves the part into a specific folder using the current name:

Save(string Folder)

Saves the part using the current path and file name:

Save()

SaveAsSaves the part into a specific folder with a new name:


SaveSnapshotSaves the current view as a bitmap image:

SaveSnapshot(string FileName, int Width, int Height, bool UseAspectRatio,bool UseWidthandHeight)

SaveThumbnailSaves a thumbnail image of the part:

SaveThumbnail(string FileName, int Width, int Height)

ScaleScaling of the part:

Feature Scale(string Name, bool AboutCenter, double ScaleFactor)

SetColorSets the color of the part:

SetColor(byte Red, byte Green, byte Blue)

ShowFeatureShows a feature on the part:


ShowFeature(string Name)

Shows a feature on the part:

ShowFeature(Feature)

SuppressFeatureSuppresses a feature on the part:

SuppressFeature(Feature)

Suppresses a feature on the part:

SuppressFeature(string Name)

UnsuppressFeatureUnsuppresses a feature on the part:

UnsuppressFeature(Feature)

Unsuppresses a feature on the part:

UnsuppressFeature(string Name)


Class: PlaneA design plane. Can be used for creating sketches

PropertiesNameType: stringThe name of the plane

FunctionsGetPartGets the part that the plane is defined in:

GetPart()



IsParallelChecks if another plane is parallel to this one:

bool IsParallel(Plane OtherPlane)


Class: PointA design point

PropertiesNameType: stringThe name of the point

FunctionsGetCoordinatesGets the coordiates of the point as a list [X, Y, Z]:

GetCoordinates()

GetPartGets the part that the point is defined in:

GetPart()




Class: PolylineA line constructed from a set of line segments

FunctionsAddArcAdds an arc to the polyline. The arc is approcimated with straight line segments:

AddArc(PolylinePoint Center, PolylinePoint Start, PolylinePoint End, intMinimumNumberofSegments)

AddCircleAdds a circle to the polyline. The circle is approximated by a polygon:

AddCircle(double CircleCenterX, double CircleCenterY, double Diameter, intNumberofSides)

AddPointAdds a new point to the polyline:

AddPoint(PolylinePoint PointtoAdd)

AddPolylineAppends a polyline to the end of this polyline:

AddPolyline(Polyline LinetoAppend)

CloneCreates a copy of a section of the polyline:

Polyline Clone(int StartPointIndex, int EndPointIndex)

Creates a copy of the polyline:

Polyline Clone()

FindIntersectionFinds the intersection between the two line segments A1A2 and B1B2:

PolylinePoint FindIntersection(PolylinePoint A1, PolylinePoint A2,PolylinePoint B1, PolylinePoint B2)

Finds the first intersection point between two polylines:

PolylinePoint FindIntersection(Polyline Line1, Polyline Line2)


FindIntersectionWithCircleFinds the first intersection between a polyline and a circle:

PolylinePoint FindIntersectionWithCircle(Polyline Line, doubleCircleCenterX, double CircleCenterY, double Radius)

InsertPointInserts a point into a specific location in the polyline. First point has an index of zero:

InsertPoint(int Index, PolylinePoint PointtoAdd)

IsPointOnLineDetermines if a point is on the line segment A1A2:

bool IsPointOnLine(PolylinePoint A1, PolylinePoint A2, PolylinePointPointtoCheck, double Tolerance)

JoinGets the combination of the polyline with another polyline appended to it:

Polyline AppendLine(Polyline LinetoAppend)

LastPointGets the last point of the polyline:

PolylinePoint LastPoint()

OffsetApplies an offset to the polyline:

Offset(double OffsetX, double OffsetY)

RemoveDuplicatesRemoves duplicate points that are next to each other:

RemoveDuplicates()

RotateZRotates the polyline:

RotateZ(double CenterofRotationX, double CenterofRotationY, double Angle)

SplitAtPointSplits a polyline at a point, creating two polylines:

ListofPolylines SplitAtPoint(PolylinePoint SplitPoint, double Tolerence)


Class: PolylinePointA single point in a polyline

PropertiesXType: doubleX coordinate

YType: doubleY coordinate

FunctionsOffsetCreates a new point by applying an offset to the point:

PolylinePoint Offset(double X, double Y)

PolylinePointCreates a new polyline point:

obj = PolylinePoint()

Creates a new polyline point:

obj = PolylinePoint(double X, double Y)

RotateZRotates the point around an origin:

RotateZ(double RotationCenterX, double RotationCenterY, double Angle)

ScaleScales the point location based on an origin:

PolylinePoint Scale(double ScaleOriginX, double ScaleOriginY, doubleScaleFactor)


Class: SketchA 2D sketch

PropertiesFiguresType: Python listA list of figures (line, circle, circulararc, bspline) defined on the sketch

NameType: stringThe name of the sketch

FunctionsAddArcAdds a circular arc to the sketch:

AddArc(CircularArc NewArc)

AddArcCenterStartAngleAdds a circular arc using center, start and angle. Arc is anti-clockwise.:

AddArcCenterStartAngle(double CenterX, double CenterY, double StartX,double StartY, double Angle, bool IsReference)

AddArcCenterStartEndAdds a circular arc using center, start and end to the sketch. Arc is anti-clockwise.:

AddArcCenterStartEnd(CenterX, CenterY, StartX, StartY, double EndX, doubleEndY, double IsReference)

AddBsplineAdds a new bspline to the sketch:

AddBspline(Bspline NewBspline)

Adds a Bspline to the sketch:

AddBspline(int Order, ListofPoints, ListofKnotVectors, ListofWeights, boolIsReference)

AddBsplineThroughPointsAdds a Bspline to the sketch through a set of points:


AddBspline(int Order, ListofPoints, bool IsReference)

AddCircleAdds a circle to the sketch:

AddCircle(double CenterX, double CenterY, double Diameter, boolIsReference)

Adds a circle to the sketch:

AddCircle(Circle NewCircle)

AddFigureAdds a figure to the sketch, e.g. circle, line, arc, bspline:

AddFigure(Figure NewFigure)

AddLineAdds a line to the sketch:

AddLine([StartPointX, StartPointY], [EndPointX, EndPointY], boolIsReference)

Adds a line to the sketch:

AddLine(double StartX, double StartY, double EndX, double EndY, boolIsReference)


AddLine(Line NewLine)

AddLinesAdds a set of lines to the sketch. The list of points is in the order [Point1X, Point1Y,Point2X, Point2Y, ...]:

AddLines(ListofPoints, bool IsReference)

Adds a set of lines to the sketch. The list of points is in the order [Point1X, Point1Y,Point2X, Point2Y, ...]:

AddLines(ListofPoints, bool IsReference)

AddPointAdds a point to the sketch:

AddPoint(double X, double Y, bool IsReference)


Adds a point to the sketch:

AddPoint(SketchPoint NewPoint)

AddPolygonAdds a regular polygon to the sketch:

AddPolygon(double CenterX, double CenterY, double Diameter, int Sides, boolIsReference)

AddPolyholeAdds a 'nophead polyhole':

AddPolyhole(double CenterX, double CenterY, double Diameter, boolIsReference)

AddPolylineAdds a polyline to the sketch:

AddPolyline(Polyline Line, bool IsReference)

AddRectangleAdds a rectangle to the sketch:

AddRectangle(double BottomLeftX, double BottomLeftY, double TopRightX,double TopRightY, bool IsReference)

CopyFromCopies another sketch into this sketch:

CopyFrom(Sketch SketchtoCopy)

Copies a sketch into this sketch with transformations.:

CopyFrom(Sketch SketchtoCopy, double Angle, double RotationCenterX, doubleRotationCenterY, double TranslateX, double TranslateY, double ScaleOriginX,double ScaleOriginY, double ScaleFactor)

GetPartGets the part that the sketch is defined on:

GetPart()




GlobaltoPointProjects a 3D point in the part coordinate system into a point on the sketch:

ListofXY GlobaltoPoint(double X, double Y, double Z)

PointtoGlobalConverts a point on the sketch into a 3D point in the part coordinate system:

ListofXYZ PointtoGlobal(double X, double Y)


Class: Sketch3DA 3D sketch

PropertiesNameType: stringThe name of the sketch

FunctionsAddArcCenterStartEndAdds a circular arc using center, start and end to the sketch. Arc is anti-clockwise.:

AddArcCenterStartEnd(CenterX, CenterY, CenterZ, StartX, StartY, StartZ,double EndX, double EndY, double EndZ)

AddBsplineAdds a Bspline to the sketch:

AddBspline([ListofPoints])

AddLineAdds a line to the sketch:

AddLine(double StartX, double StartY, double StartZ, double EndX, doubleEndY, double EndZ)


AddLine([StartPointX, StartPointY, StartPointZ], [EndPointX, EndPointY,EndPointZ])

AddLinesAdds a set of lines to the sketch. The list of points is in the order [Point1X, Point1Y,Point1Z, Point2X, Point2Y, Point2Z, ...]:

AddLines(ListofPoints)

AddPointAdds a point to the sketch:

AddPoint(SketchPoint3D NewPoint)


Adds a point to the sketch:

AddPoint(double X, double Y, double Z)

GetPartGets the part that the sketch is defined on:

GetPart()




Class: SketchPointA sketch point

PropertiesIsReferenceType: boolTrue if the point is a reference point, false if it is a regular point

XType: doubleX-coordinate of point

YType: doubleY-coordinate of point

FunctionsSketchPointCreates a new sketch point which can be added to sketches:

obj = SketchPoint(double X, double Y, bool IsReference)


Class: SketchPoint3DA 3D sketch point

PropertiesIsReferenceType: boolTrue if the point is a reference point, false if it is a regular point

XType: doubleX-coordinate of point

YType: doubleY-coordinate of point

ZType: doubleZ-coordinate of point

FunctionsSketchPoint3DCreates a new 3D sketch point which can be added to sketches:

obj = SketchPoint3D(double X, double Y, double Z, bool IsReference)

Creates a new 3D sketch point which can be added to sketches:

obj = SketchPoint3D(double X, double Y, double Z, bool IsReference)


Class: UnitsDefines the current units used by the functions

PropertiesCurrentType: UnitTypesThe current units


Enumeration: UnitTypesSupported units

• Millimeters• Centimeters• Inches


Class: VertexDescribes a vertex

PropertiesNameType: stringThe name of the vertex

XType: doubleX-coordinate of vertex

YType: doubleY-coordinate of vertex

ZType: doubleZ-coordinate of vertex

FunctionsGetPartGets the part that the vertex is defined on:

GetPart()




Class: WindowsGraphical user interface creation and interaction

FunctionsErrorDialogShows an error window:

void ErrorDialog(string Message, string Title)

GetInputValueGets the current value of a dialog input:

object GetInputValue(InputIndex)

InfoDialogShows an information window:

void InfoDialog(string Message, string Title)

OpenFileDialogPrompts user to select a file. Returns path and name if selected, empty string ifcanceled. Example filter: 'Part Files|*.AD_PRT':

string OpenFileDialog(string Title, string Filter, string DefaultExtension)

OptionsDialogShows a dialog prompting the user to enter values. Inputs are defined as [[Name, Type,DefaultValue], [...]]:

ListofValues OptionsDialog(string Title, ListofInputs, InputAreaWidth)

QuestionDialogShows a question window. Returns True if 'yes' was clicked:

bool QuestionDialog(string Question, string Title)

SaveFileDialogPrompts user for a location to save a file. Returns path and name if selected, emptystring if canceled. Example filter: 'Part Files|*.AD_PRT':

string SaveFileDialog(string Title, string Filter, string DefaultExtension)

SetInputValueSets the current value of a dialog input:


SetInputValue(InputIndex, Value)

SetStringListUpdates the list of strings for a stringlist input:

SetStringList(InputIndex, ListofStrings)

UtilityDialogShows a dialog prompting the user to enter values. Inputs are defined as [[Name, Type,DefaultValue], [...]]:

UtilityDialog(string Title, string ActionButtonText, ActionButtonFunc,InputChangedFunc, ListofInputs, InputAreaWidth)


Enumeration: WindowsInputTypesType of Windows input

• String• Integer• Real• Boolean• Face• Plane• Edge• Vertex• Point• Axis• Sketch• Sketch3D• File• Label• SaveFile• StringList• Image• Url

wizoscriptreference - pcloud - file security made simple ... design/wizoscri… ·...

Documents