[Artwork] / [QisMLib] / [Programmer's Corner]

QisMLOA Extension

QisMLOA C++ API (qismloa.h)

QisMLOAstream

• Represents a callback handler that receives the annotation items as a GDS-style stream

class QisMLOAstream { ... };

Version control (QisMLOAstream)

• Cast to a pointer of another version in the class hierarchy (base/derived)
• Get the latest version number. Version numbers start at 1 and are reflected in the class name using the suffix V<number>. E.g <baseclass>V<version>
• The topmost base class is version 1 (V1 implied)
• The cast returns NULL if a version number is not recognized/implemented

xxxxxxxxxx
virtual const char* QisMLOAstream_name(const int version) const = 0;
virtual void* QisMLOAstream_cast(const int version) = 0;
virtual const void* QisMLOAstream_cast(const int version) const = 0;
virtual int QisMLOAstream_latest_version() const = 0;

Begin_loa_stream

• Signals the start of the stream for a given set of annotations
• units_m is the stream units in meter
• grid_m is the stream resolution in meter
• Return 0 to continue, non-zero to terminate the stream

xxxxxxxxxx
virtual int Begin_loa_stream(const double units_m, const double grid_m) { return 0; }

Begin_loa_pattern

• Signals the start of a new cell (pattern) definition
• name is the name of this cell
• Return 0 to continue, non-zero to terminate the stream

xxxxxxxxxx
virtual int Begin_loa_pattern(const char* name) { return 0; }

Add_loa_boundaries

• Represents a single annotation item converted to a set of boundaries
• n is the number of boundaries in the set
• nv is an array of n elements where each element 0 <= i < n is the number of vertices for the corresponding boundary in the set
• xy is an array of n xy-coordinates where each element 0 <= i < n corresponds to boundary i. Each element is in turn an array of x,y pairs. The number of pairs is determined by nv for i
• lnum and dnum represents the layer assigned to this annotation. It can be set during New_annotation_set. Default is 0:0
• Return 0 to continue, non-zero to terminate the stream

xxxxxxxxxx
virtual int Add_loa_boundaries(
  const int* const* xy, const int* nv, const int n, const unsigned short lnum, 
  const unsigned short dnum
  ) { return 0; }

Add_loa_reference

• The annotation stream can be set to hierarchical or flat in Set_to_stream
• In hierarchical mode, annotations are separated into their own cell definitions and then aggregated in a TOP cell using cell references
• pattern_name is the name of the cell being referenced in TOP
• x and y represent the insertion point in database units (dbu)
• scale, angle and flip_y represent the transformation parameters for this reference. angle is in degrees
• Return 0 to continue, non-zero to terminate the stream

xxxxxxxxxx
virtual int Add_loa_reference(
  const char* pattern_name, const int x, const int y, const double scale, 
  const double angle, const bool flip_y
  ) { return 0; }

End_loa_pattern

• Signals the end of a cell definition
• Return 0 to continue, non-zero to terminate the stream

xxxxxxxxxx
virtual int End_loa_pattern() { return 0; }

End_loa_stream

• Signals the end of the annotation stream
• Return 0 to continue, non-zero to terminate the stream

xxxxxxxxxx
virtual int End_loa_stream() { return 0; }

Get_error_msg

• In case the stream was abruptly terminated by returning a non-zero code via the callbacks, use this to return a suitable error message

xxxxxxxxxx
virtual const char* Get_error_msg(const int ret) const { return ""; }

QisMLOAsetPrm

• Represents the options applied to the entire annotation set during creation

xxxxxxxxxx
struct QisMLOAsetPrm { enum Code { ... }; };

• Option to specify the directory containing the font files
• If this is not used, the env. variable ACSLIB_TTF_FONTDIR MUST be set to such a directory. Otherwise, adding LOA_E_ANNTYP_TEXT annotations will fail
• MUST be followed by one const char* representing the directory path

xxxxxxxxxx
#define LOA_S_SETPRM_TTF_FNTDR "ttf_dir=%s"
LOA_E_SETPRM_TTF_FNTDR=1

• Option to specify the writeable directory to be used to create intermediate font files
• If this is not used, the env. variable ACSLIB_FONTDIR MUST be set to such a directory. Otherwise, adding LOA_E_ANNTYP_TEXT annotations will fail
• MUST be followed by one const char* representing the directory path

xxxxxxxxxx
#define LOA_S_SETPRM_FNTDR "font_dir=%s"
,LOA_E_SETPRM_FNTDR

• Option to set the stroke weight for polygons generated from fonts with path data. The width of stroked text is 1/stroke_weight the height of the text.
• MUST be followed by one double
• Used for LOA_E_ANNTYP_TEXTtions
• Default : 10.0 user units

xxxxxxxxxx
#define LOA_S_SETPRM_STRK_WGHT "stroke_weight=%lf"
,LOA_E_SETPRM_STRK_WGHT

• Option to set the spacing (>0.001 user units) for annotation with multiple lines for LOA_E_ANNTYP_TEXT annotations
• MUST be followed by one double
• Line spacing scales based on the text height
• Default : 1.2 user units

xxxxxxxxxx
#define LOA_S_SETPRM_LN_SPCNG "line_spacing=%lf"
,LOA_E_SETPRM_LN_SPCNG

• Option to set the slant in degrees for the LOA_E_ANNTYP_TEXT annotations
• MUST be followed by one double
• Must be between -45.0 and 45.0 degrees inclusive
• Default : 0.0 degrees

xxxxxxxxxx
#define LOA_S_SETPRM_SLNT "slant=%lf"
,LOA_E_SETPRM_SLNT

Option to set the x/y aspect ratio for the LOA_E_ANNTYP_TEXT annotations

• MUST be followed by one double
• Values above 1 will widen the content
• values below 1 will narrow the content
• Must be > 0.0
• Default : 1.0

xxxxxxxxxx
#define LOA_S_SETPRM_ASPCT "aspect=%lf"
,LOA_E_SETPRM_ASPCT

• Toggle to smooth out fonts with arcs. This works in conjunction with LOA_E_SETPRM_ARCRES and LOA_E_SETPRM_CHRDERR
• MUST be followed by one int -- 1 (on) or 0 (off)
• Default : 1 (on)

xxxxxxxxxx
#define LOA_S_SETPRM_CRCLR "circularize=%d"
,LOA_E_SETPRM_CRCLR

• Sets the arc resolution for a particular set. This setting will keep reconstituted arcs within a certain distance of the original arc. Works in conjunction with LOA_E_SETPRM_CHRDERR
• MUST be followed by one double
• Default : 45.0 degrees

xxxxxxxxxx
#define LOA_S_SETPRM_ARCRES "arcres=%lf"
,LOA_E_SETPRM_ARCRES

• Sets the arc recovery and chord error values
• MUST be followed by two double -- font arc recovery and font chord error
• Default : 2.5,1.0

xxxxxxxxxx
#define LOA_S_SETPRM_CHRDERR "arcsag=%lf,%lf"
,LOA_E_SETPRM_CHRDERR

• Sets the pixel size conversion factor
• MUST be followed by one double
• Default : 1.0

xxxxxxxxxx
#define LOA_S_SETPRM_PXLSZ_FCTR "pixel_size_factor=%lf"
,LOA_E_SETPRM_PXLSZ_FCTR

• Toggles if bitmaps added via a buffer (LOA_E_ANNTYP_BUFR) will have the image buffer persist during the execution or not
• MUST be followed by one int -- 1 or 0
• 1 (yes) means that the library will not copy the buffer passed because it will remain persistent during the life of the set
• 0 (no) means that the library will copy the buffer because the passed buffer might expire during execution
• Default : 0 (no)

xxxxxxxxxx
#define LOA_S_SETPRM_BUF_PRST "buffer_persist=%d"
,LOA_E_SETPRM_BUF_PRST

• Set the union mode for annotations
• MUST be followed by one 'const char*' -- "on" or "off" or "cutline" or "butting"
• "on" / "cutline" indicates unionization with cutlines
• "butting" indicates unionization with butting edges
• "off" indicates unionization is off for bitmap and stroke annotations (font based annotations are always unionized)
• Default : "on"

xxxxxxxxxx
#define LOA_S_SETPRM_UNION "union=%s" //off | butting | (cutline | on)
,LOA_E_SETPRM_UNION

• Set the size interval which sorting will be triggered for entries
• MUST be followed by one int
• Default : 100,000. Sort or re-sort every 100,000 entries

xxxxxxxxxx
#define LOA_S_SETPRM_SRT_SZ "sort_size=%d"
,LOA_E_SETPRM_SRT_SZ

• Set the layer:datatype for the annotations in the output stream
• MUST be followed by two int -- 0 <= lnum < 65536 and 0 <= dnum < 65536
• Default : 0:0

xxxxxxxxxx
#define LOA_S_SETPRM_OUT_LYR "out_layer=%d:%d"
,LOA_E_SETPRM_OUT_LYR

• Sets the no. of threads to be used during Set_to_stream
• Default : 0 (no. cpus)

xxxxxxxxxx
#define LOA_S_SETPRM_THRNUM "thrnum=%d"
,LOA_E_SETPRM_THRNUM

QisMLOAnnTyp

• Represents the various types of annotations that can be defined

xxxxxxxxxx
struct QisMLOAnnTyp { enum Code { ... }; };

• Annotation defined by a bitmap file on disk
• MUST be followed by one const char* representing the file path
• Only Artwork's RAW format is supported at the moment

xxxxxxxxxx
#define LOA_S_ANNTYP_FILE "ann_file=%s"
LOA_E_ANNTYP_FILE=1

• Annotation defined by a text string
• MUST be followed by two const char* - text string, font name followed by one double - font height (user units) (>0.0)
• Font name is the name of the file (.ttf, .shx) representing the font
• The font file MUST be present in the path set by LOA_E_SETPRM_TTF_FNTDR or the env. variable ACSLIB_TTF_FONTDIR
• LOA_E_SETPRM_FNTDR or the environment variable ACSLIB_FONTDIR MUST be set to a writable directory where intermediate font files will be created
• A line feed can be inserted in the text string using two characters \\ (backslash) and r
• Text string can contain spaces

xxxxxxxxxx
#define LOA_S_ANNTYP_TEXT "ann_text=%s,%s,%lf"
,LOA_E_ANNTYP_TEXT

• Annotation defined by an image in a memory buffer
• MUST be followed by one unsigned char* representing the buffer pointer, two int representing width and height in pixels
• Depending on the LOA_E_SETPRM_BUF_PRST setting applied during the creation of the set, either the image will be copied (default) or the buffer will be expected to persist until the destruction of the set

xxxxxxxxxx
#define LOA_S_ANNTYP_BUFR "ann_bufr=%p,%d,%d"
,LOA_E_ANNTYP_BUFR

QisMLOAnnItm

• Represents options used to flavor annotations

xxxxxxxxxx
struct QisMLOAnnItm { enum Code { ... }; };

• Option to translate the annotation along X and Y axes
• MUST be followed by two double representing x and y offsets respectively in user units
• Default : 0,0

xxxxxxxxxx
#define LOA_S_ANNITM_TXY "translate=%lf,%lf"
LOA_E_ANNITM_TXY=1

• Option to rotate the annotation about a point
• MUST be followed by three double representing the angle (degrees), x and y anchor point in user units
• Default : 0,0,0

xxxxxxxxxx
#define LOA_S_ANNITM_ANGLE "angle=%lf,%lf,%lf"
,LOA_E_ANNITM_ANGLE

Option to mirror the annotation about the Y axis (along X)

• MUST be followed by one double representing the anchor point
• Default : No mirroring

xxxxxxxxxx
#define LOA_S_ANNITM_MIRROR_X "mirror_x=%lf"
,LOA_E_ANNITM_MIRROR_X

Option to mirror the annotation about the X axis (along Y)

• MUST be followed by one double representing the anchor point
• Default : No mirroring

xxxxxxxxxx
#define LOA_S_ANNITM_MIRROR_Y "mirror_y=%lf"
,LOA_E_ANNITM_MIRROR_Y

• Option to invert the annotation
• MUST be followed by one int 1 (on) or 0 (off)
• Default : 0 (off)

xxxxxxxxxx
#define LOA_S_ANNITM_INVERT "invert=%d"
,LOA_E_ANNITM_INVERT

• Option to scale the annotation (only for LOA_S_ANNTYP_FILE and LOA_S_ANNTYP_BUFR types)
• MUST be followed by one double representing the scaling (>0.0)
• Default : 1.0

xxxxxxxxxx
#define LOA_S_ANNITMFILE_SCALE "scale=%lf"
,LOA_E_ANNITMFILE_SCALE

Option to justify a text annotation (type LOA_S_ANNTYP_TEXT)

• MUST be followed by two int representing the justification as follows

  • first int represents horizontal justification
  • second int represents vertical justification

• Horizontal justification : 0 (left) or 1 (center) or 2 (right)

• Vertical justification : 0 (top) or 1 (middle) or 2 (bottom) or 3 (baseline of the first line)

• Default : 0,0 (left, top)

xxxxxxxxxx
#define LOA_S_ANNITMTEXT_JSTFY "justify=%d,%d"
,LOA_E_ANNITMTEXT_JSTFY

Option to add border to a text annotation (type LOA_S_ANNTYP_TEXT)

• MUST be followed by two double representing the margin and frame thickness in user units
• Default : no border

xxxxxxxxxx
#define LOA_S_ANNITMTEXT_BORDER "border=%lf,%lf"
,LOA_E_ANNITMTEXT_BORDER

QisMLOAmerge

• Represents the options to be used for merging a set of annotations with a source database
• At the moment, can only be used in string format

xxxxxxxxxx
struct QisMLOAmerge { enum Code { ... }; };

• Set the view cell (from the source database)
• MUST be followed by a const char* representing the cell name
• Default : deepest top cell of the source db QisMFile::Get_default_top_cell()

xxxxxxxxxx
#define LOA_S_MERGE_VCELL "viewcell=%s" //string format
LOA_E_MERGE_VCELL=1 //enum code

• Set a list of comma-separated layers (and optionally datatypes) indicating that only the specified layers will be extracted from the source
• MUST be followed by a const char* representing the layer string
• e.g "1,2:2,3,4:4,4:8"
• Default : "ALL"

xxxxxxxxxx
#define LOA_S_MERGE_LYRS "layers=%s" //string format
,LOA_E_MERGE_LYRS //enum code

• Set the name of the output top cell
• MUST be followed by a const char* representing the cell name
• Default : Same name as a view cell from the source

xxxxxxxxxx
#define LOA_S_MERGE_TOP "top=%s" //string format
,LOA_E_MERGE_TOP //enum code

• Set the output file format to OASIS
• No additional values needed
• Default : LOA_E_MERGE_GDS or "gdsii"

xxxxxxxxxx
#define LOA_S_MERGE_OAS "oasis" //string format
,LOA_E_MERGE_OAS //enum code

• Set the output file format to GDSII
• No additional values needed
• Default : LOA_E_MERGE_GDS or "gdsii"

xxxxxxxxxx
#define LOA_S_MERGE_GDS "gdsii" //string format
,LOA_E_MERGE_GDS //enum code

QisMLOAset

• Represents the interface to a set of annotations

xxxxxxxxxx
class QisMLOAset { ... };

Version control (QisMLOAset)

• Cast to a pointer of another version in the class hierarchy (base/derived)
• Get the latest version number. Version numbers start at 1 and are reflected in the class name using the suffix V<number>. E.g <baseclass>V<version>
• The topmost base class is version 1 (V1 implied)
• The cast returns NULL if a version number is not recognized/implemented

xxxxxxxxxx
virtual const char* QisMLOAset_name(const int version) const = 0;
virtual void* QisMLOAset_cast(const int version) = 0;
virtual const void* QisMLOAset_cast(const int version) const = 0;
virtual int QisMLOAset_latest_version() const = 0;

Get_error_msg (QisMLOAset)

Get_error_tag (QisMLOAset)

Get_error_context (QisMLOAset)

• Get the error message, tag and context for the specified error condition represented by code returned by the corresponding operation

xxxxxxxxxx
virtual const char* Get_error_msg(const int code) const = 0;
virtual const char* Get_error_tag(const int code) const = 0;
virtual const char* Get_error_context(const int code) const = 0;

Begin_annotation_item

• Begin the definition of a new annotation item in the set
• anntyp_code is an integer code that represents the type of annotation using one of the QisMLOAnnTyp enums.
• ... represents the additional arguments required to define this type. The number, types and order of these arguments are described next to the corresponding enum
• Returns 0 on success. Otherwise use Get_error... for details

xxxxxxxxxx
virtual int Begin_annotation_item(const int anntyp_code, ...) = 0;

Add_item_param

Add_item_param_str

• Add optional parameters corresponding to the annotation being defined
• anntyp_code is an integer code that represents the parameter to be added using one of the QisMLOAnnItm enums.
• ... represents the additional values for this parameter. The number, types and order of these values are described next to the corresponding enum
• One can add a set of parameters at once in form of a string params. The individual parameters are separated by spaces and those with spaces in them are bounded by " double quotes
• Returns 0 on success. Otherwise use Get_error... for details

xxxxxxxxxx
virtual int Add_item_param(const int annitm_code, ...) = 0;
virtual int Add_item_param_str(const char* params) = 0;

Commit_annotation_item

• End and commit (save) the annotation being defined
• Any options added this point on will be disregarded
• An annotation is not saved to the set unless committed
• Returns 0 on success. Otherwise use Get_error... for details

xxxxxxxxxx
virtual int Commit_annotation_item() = 0;

Set_to_stream

• Receive all annotations from the set as a GDSII-like stream

• flat set the stream mode.

  • true implies no hierarchy. i.e there is only one cell TOP that contains all the boundaries representing all the annotations.
  • false implies hierarchical. i.e, annotations have their own cell definitions. they are aggregated (referenced) in the TOP cell

• client is a handle to the stream handler

• opts is reserved for future use

• Returns 0 on success. Otherwise use Get_error... for details

xxxxxxxxxx
virtual int Set_to_stream(
  const bool flat, QisMLOAstream* client, const char* opts
  ) = 0;

QisMLOA

• Represents the primary interface to the QisMLOA extension

xxxxxxxxxx
class QisMLOA: public NsQisMLib::QisMExtensionAPI { ... };

Version control (QisMLOA)

• Cast to a pointer of another version in the class hierarchy (base/derived)
• Get the latest version number. Version numbers start at 1 and are reflected in the class name using the suffix V<number>. E.g <baseclass>V<version>
• The topmost base class is version 1 (V1 implied)
• The cast returns NULL if a version number is not recognized/implemented

xxxxxxxxxx
virtual const char* QisMLOA_name(const int version) const = 0;
virtual void* QisMLOA_cast(const int version) = 0;
virtual const void* QisMLOA_cast(const int version) const = 0;
virtual int QisMLOA_latest_version() const = 0;

Get_error_msg (QisMLOA)

Get_error_tag (QisMLOA)

Get_error_context (QisMLOA)

• Get the error message, tag and context for the specified error condition represented by code returned by the corresponding operation

xxxxxxxxxx
virtual const char* Get_error_msg(const int code) const = 0;
virtual const char* Get_error_tag(const int code) const = 0;
virtual const char* Get_error_context(const int code) const = 0;

Reset_set_params

• Reset the parameters used to initialize an annotation set

xxxxxxxxxx
virtual void Reset_set_params() = 0;

Add_set_param

• Add a parameter to initialize an annotation set
• setprm_code is an integer code that represents the parameter to be added using one of QisMLOAsetPrm enums.
• ... represents the additional values for this parameter. The number, types and order of these values are described next to the corresponding enum
• Returns true if the setprm_code is recognized and accepted

xxxxxxxxxx
virtual bool Add_set_param(const int setprm_code, ...) = 0;

Get_set_params_str

• Get the entire list of parameters used to initialize the annotation set as a c-string

xxxxxxxxxx
virtual const char* Get_set_params_str() const = 0;

New_annotation_set

Delete_annotation_set

• Create and destroy a new annotation set
• units_m and grid_m represents the units and resolution for the set in meter
• loa_setprm_str is a string of parameters separated by spaces
• ecode is address to store the error code (on failure)
• Requires ONE license of QisMLOA (4250) for each call to New_annotation_set
• The acquired license is released by Delete_annotation_set
• Returns a handle to the newly created set on success. Otherwise, use ecode and Get_error... for details
• Every annotation set MUST be eventually destroyed to avoid resource leaks

xxxxxxxxxx
virtual QisMLOAset* New_annotation_set(
  const double units_m, const double grid_m, const char* loa_setprm_str, 
  int* ecode
  ) = 0;
virtual void Delete_annotation_set(QisMLOAset* handle) = 0;

Merge_annotations_and_db

• Merge the specified annotation set with a source DB in form of a GDSII/OASIS file on disk
• filedb is a handle to a valid QisMLib DB. Cannot be NULL or empty
• annotations is a handle to the set of annotations to be added (can be NULL or empty)
• output_base is the path (dir + name) of the output file. extension (.gds or .oas) will be automatically added based on the format
• merge_opts is a string of parameters separated by spaces. See QisMLOAmerge for a list of parameters and their syntax
• Returns 0 on success. Otherwise, use Get_error... for details

xxxxxxxxxx
virtual int Merge_annotations_and_db(
  NsQisMLib::QisMFile* filedb, QisMLOAset* annotations, 
  const char* output_base, const char* merge_opts
  ) = 0;

QisMLOA Licensing (API)

• Code : 4250
• Acquire : QisMLOA::New_annotation_set(..)
• Release : QisMLOA::Delete_annotation_set(..)
• Policy : One per call

QisMLOA Version History

qismloa dll v1.0 2022-06-08

• First cut

LOAclient Command-line (loaclient64.exe)

xxxxxxxxxx
loaclient +{REQUIRED} [-{OPTIONS}]

Required

GDSII/OASIS source file

xxxxxxxxxx
+input:{input_gds_oas_path}

• Specify the path of a valid GDSII/OASIS/DBLOAD file that serves as the primary data source

Output path (base)

xxxxxxxxxx
+out:{output_dir+filename}

• Specify the directory + filename of the output file
• The extension (.gds or .oas) will be added automatically based on the output format

Optional : Source

Layers of interest

xxxxxxxxxx
[-layers:{layer_str}]

• Specify a comma-separated list of layers to extract
• E.g 1,2:2,3,4:4,4:8 extracts all data types of 1 and 3, only 2:2 for layer 2 and 4:4 and 4:8 for layer 4
• Default : "ALL" (all layers from the source)

View cell

xxxxxxxxxx
[-viewcell:{source_cell_name}]

• Specify the view cell from the source that will become the top cell in the output
• Default : deepest top cell of the source

Output top cell name

xxxxxxxxxx
[-topcell:{output_top_cell_name}]

• Specify the name of the top cell in the output
• Default : same as the source view cell

Drop TEXT elements

xxxxxxxxxx
[-notext]

• If specified, all GDSII/OASIS TEXT elements will be ignored during extraction
• Default : TEXT elements are extracted as-is

OASIS output

xxxxxxxxxx
[-oasis]

• If specified, the output file will be an OASIS (.oas) file
• Default : Output is GDSII (.gds)

Optional : Add Annotation Items

TEXT based annotations

xxxxxxxxxx
{ -add:TEXT,{text_str},{font_name},{font_height} ... }* 

• Add one or more annotations based on a text-string

• {text_str} represents the annotation string

  • Can contain one or more <space> (if the argument is fully enclosed in double-quotes)
  • Can contain one or more <new-line> represented by two characters --
  • At the moment, Cannot contain a <comma>

• {font_name} is the name of the font file to be used to render this annotation

  • The font file MUST be present in the TTF directory either specified as an option or set to the ACSLIB_TTF_FONTDIR env. variable

• {font_height} represents the height of the annotation text in user units

• This annotation item can be flavored further by specifying more options

Translation

xxxxxxxxxx
[-translate:{x},{y}]

• Translate the previously defined annotation to the specified point {x},{y} in user units in the design (top cell) space

Rotation

xxxxxxxxxx
[-angle:{deg},{x},{y}]

• Rotate the previously defined annotation about a point {x},{y} by {deg} degress in the design (top cell) space

Mirror (flip X)

xxxxxxxxxx
[-mirror:x,{anchor_pt}]

• Reflect the annotation along X about the specified {anchor_pt} (x) value

Mirror (flip Y)

xxxxxxxxxx
[-mirror:y,{anchor_pt}]

• Reflect the annotation along Y about the specified {anchor_pt} (y) value

Invert

xxxxxxxxxx
[-invert]

• Invert the annotation -- polygons for this annotation represent the blank space within the extents of the annotation
• Default : polygons for this annotation represent the space within the rendered text string

Justification

xxxxxxxxxx
[-justify:{horizontal 0-2},{vertical 0-3}]

• Specify justification for the text using two numbers w.r.t text extents
• Horizontal justification : 0 (left) or 1 (center) or 2 (right)
• Vertical justification : 0 (top) or 1 (middle) or 2 (bottom) or 3 (baseline of the first line)
• Default : 0,0 (left, top)

Border

xxxxxxxxxx
[-border:{margin},{frame}]

• Specify a border to be added to this text annotation
• {frame} is the thickness of the frame in user units
• `{margin} is the gap between the text and the frame in user units
• Default : No border

Bitmap based

xxxxxxxxxx
{ -add:FILE,{file_path} ... }*

• Add annotation defined by a bitmap file on disk
• Only Artwork's RAW format is supported at the moment

Artwork RAW Format

xxxxxxxxxx
'L''G''R''A''W''0''0'<width-in-pixels><height-in-pixels><image-bytes-size><image-bytes>

• <width-in-pixels> : 4 bytes
• <height-in-pixels> : 4 bytes
• <image-bytes-size> : 8 bytes
• <image-bytes> : <image-bytes-size> bytes

Translation

xxxxxxxxxx
[-translate:{x},{y}]

• Translate the previously defined annotation to the specified point {x},{y} in user units in the design (top cell) space
• Default : No translation (0,0)

Rotation

xxxxxxxxxx
[-angle:{deg},{x},{y}]

• Rotate the previously defined annotation about a point {x},{y} by {deg} degress in the design (top cell) space
• Default : No rotation (0,0,0)

Mirror (flip X)

xxxxxxxxxx
[-mirror:x,{anchor_pt}]

• Reflect the annotation along X about the specified {anchor_pt} (x) value
• Default : No mirror along X

Mirror (flip Y)

xxxxxxxxxx
[-mirror:y,{anchor_pt}]

• Reflect the annotation along Y about the specified {anchor_pt} (y) value
• Default : No mirror along Y

Invert

xxxxxxxxxx
[-invert]

• Invert the annotation -- polygons for this annotation represent the blank space within the extents of the annotation
• Default : polygons for this annotation represent the space within the rendered text string

Scale

xxxxxxxxxx
[-scale:{value}]

• Scale the bitmap annotation (>0.0)
• Default : 1.0

Optional : For all annotation items

Font repository

xxxxxxxxxx
[-ttf_dir:{ttf_font_dir}]

• Specify the directory containing the font files
• If this is not used, the env. variable ACSLIB_TTF_FONTDIR MUST be set to such a directory. Otherwise, adding text annotations will fail

Font scratchpad

xxxxxxxxxx
[-font_dir:{font_dir}]

• Specify the writeable directory to be used to create intermediate font files
• If this is not used, the env. variable ACSLIB_FONTDIR MUST be set to such a directory. Otherwise, adding text annotations will fail

Font weight

xxxxxxxxxx
[-stroke_weight:{value}]

• Set the stroke weight for polygons generated from fonts with path data. The width of stroked text is 1/stroke_weight the height of the text.
• Default : 10.0 user units

Line spacing

xxxxxxxxxx
[-line_spacing:{value}]

• Set the spacing (>0.001 user units) for annotation with multiple lines for LOA_E_ANNTYP_TEXT annotations
• Line spacing scales based on the text height
• Default : 1.2 user units

Slant

xxxxxxxxxx
[-slant:{value}]

• Set the slant in degrees for the text annotations
• Must be between -45.0 and 45.0 degrees inclusive
• Default : 0.0 degrees

Aspect ratio

xxxxxxxxxx
[-aspect:{ratio}]

• Set the x/y aspect ratio for the text annotations
• Values above 1 will widen the content
• values below 1 will narrow the content
• Must be > 0.0
• Default : 1.0

Circularization

xxxxxxxxxx
[-circularize]

• Toggle to smooth out fonts with arcs. This works in conjunction with Arc Resolution and Chord Error
• Default : 1 (on)

Font Arc Resolution

xxxxxxxxxx
[-arcres:{degrees}]

• Set the arc resolution for a particular set. This setting will keep reconstituted arcs within a certain distance of the original arc. Works in conjunction with LOA_E_SETPRM_CHRDERR
• MUST be followed by one double
• Default : 45.0 degrees

Font Chord Error

xxxxxxxxxx
[-chord_error:{font_arc_recov},{font_chord_err}]

• Sets the arc recovery and chord error values
• Default : 2.5,1.0

Pixel Size Factor

xxxxxxxxxx
[-px_size_factor:{value}]

• Sets the pixel size conversion factor
• Default : 1.0

Union mode

xxxxxxxxxx
[-union:off | butting | cutline | on]

• Set the union mode for annotations
• "on" / "cutline" indicates unionization with cutlines
• "butting" indicates unionization with butting edges
• "off" indicates unionization is off for bitmap and stroke annotations (font based annotations are always unionized)
• Default : "on"

Sorting size

xxxxxxxxxx
[-sort_sz:{value}]

• Set the size interval which sorting will be triggered for entries
• Default : 100,000. Sort or re-sort every 100,000 entries

Annotation layer

xxxxxxxxxx
[-ann_lyr:{lnum}:{dnum}]

• Set the layer:datatype for the annotations in the output
• Default : 0:0

Threading Control

xxxxxxxxxx
[-thrnum:{n}]

• Set the no. of threads to be used during the merge
• Default : 0 (no. cpus)

Optional : Progress updates

Logging

xxxxxxxxxx
[-log:{file_path} | -log+:{file_path}]

• Enable logging at the specified {file_path}
• -log: creates a new file while -log+: appends to an existing file

Console

xxxxxxxxxx
[-silent]

• Turn off messaging on the colsole (stdout/stderr)

LOAclient Licensing

• Code : 11003 (QisMLib), One per active process
• Code : 4250 (QisMLOA), One per active process

LOAclient Version History

loaclient exe v1.0 2022-06-08

• First cut