Job Related Global Methods

From SDK
Jump to navigation Jump to search
Back.jpg

These methods do what? (need info here)

CloseCurrentJob()

Close the current job. Same as preforming the Menu: File | Close action. Note: if there are any unsaved changes, the user will be prompted to Save before closing.

CreateNewJob()

CreateNewJob( string name, Box2D bounds, double thickness, bool in_mm, bool origin_on_surface) Creates a new job with passed name, and settings. Returns true if job created OK else false.

name - string - name for job (without extension)
bounds - Box2D - the 2d bounding box for the job area
thickness - double - thickness of material block
in_mm - bool - true if job is in mm, else in inches
origin_on_surface - true if z zero on material surface, else on machine bed

CreateNew2SidedJob()

CreateNew2SidedJob( string name, Box2D bounds, double thickness, bool in_mm, bool origin_on_surface, SideFlipDirection flip_direction) Creates a new two sided job using the given parameters. Return true if the job was created, otherwise, false.

name - string - name for job (without extension)
bounds - Box2D - the 2d bounding box for the job area
thickness - double - thickness of material block
in_mm - bool - true if job is in mm, else in inches
origin_on_surface - true if z zero on material surface, else on machine bed flip_direction – the axis around which we flip the job (VectricJob.AROUND_X or VectricJob.AROUND_Y)


CreateNewRotaryJob()

CreateNewRotaryJob( string name, double length, double diameter, MaterialBlock.XYOrigin xy_origin, bool in_mm, bool origin_on_surface, bool wrapped_along_x_axis)

Creates a new two-sided job using the given parameters. Return true if the job was created, otherwise, false.

name - string - name for job (without extension)
length - double - the length of the material cylinder (Accessible from MaterialBlock.CylinderLength)
diameter – double – the diameter of the material cylinder (Accessible from MaterialBlock.CylinderDiameter)
xy_origin – MaterialBlock.XYOrigin – The XY origin of the block (Maps to the enum values of MaterialBlock.XYOrigin)
in_mm – bool – true if the job is in mm, else in inches
origin_on_surface – bool – true if z zero on material surface, else on machine bed
wrapped_along_x_axis – bool – true if we’re wrapping along the X axis and wrapping the Y values (Accessible from MaterialBlock.RotationAxis)


OpenExistingJob()

OpenExistingJob(string pathname)

Opens an existing CRV or CRV3D file. Returns true if file opened OK, else false

pathname - string - path to file


SaveCurrentJob()

Save the current job - same as File - Save, if no path has been set for the job this method will display the File Save As dialog.

Helper methods for creating and accessing objects on layers ...


Back.jpg

References

Please Note: The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 10.0, published August 21, 2019. by Vectric Ltd. Most current document from Vertric can be downloaded at Vertric Developer Information