GendL Application - TYPESET-BLOCK

Object: TYPESET-BLOCK (The :GEOM-BASE Package)

Description

Block of text typeset using cl-typesetting. This object wraps the typeset block as a standard GDL object, so it can be placed in a view and positioned according to normal GDL positioning. You can specify the width, and by default this object will compute its length automatically from the typeset content, to fit all the lines of text into the box. Because of this computed behavior of the length, the center of the box will not, in general, be in a known location compared to the start of the text. Because of this it is recommended to use :corner, rather than :center, for positioning a base-view which contains a typeset block. In the normal case, if you want a single block in a view on a drawing, you should make the base-view object have the same width and length as the typeset-block. The base-view should also probably have :left-margin 0 and :front-margin 0.

Input Slots (optional)

BOUNDING-BOX [from BASE-OBJECT] list of two 3d points
The left front bottom and right rear top corners, in global coordinates, of the rectangular volume bounding the tree of geometric objects rooted at this object.

CENTER 3d-point
Center of the text. Specify this or start, not both. note: that the center is no longer defaulting (so that it can self-compute properly when start is specified), so it is necessary to explicitly give either start or center for general-note.

HIDDEN? [from VANILLA-MIXIN] boolean*
Indicates whether the object should effectively be a hidden-object even if specified in :objects. Default is nil.

IMAGE-FILE [from BASE-OBJECT] pathname or string
Points to a pre-existing image file to be displayed instead of actual geometry for this object. Defaults to nil

LENGTH number
The length of the box to contain the compiled content. Defaults is (the length-default), which will exactly fit the compiled content into the specified width. If you override it to be less than this default, the content will be cropped.

LOCAL-BOX [from BASE-OBJECT] list of two 3d points
The left front bottom and right rear top corners, in global coordinates, of the rectangular volume bounding this geometric object.

OBLIQUENESS [from BASE-OBJECT] 3x3 orthonormal matrix of double-float numbers
This is synonymous with the `orientation`.

ONCLICK-FUNCTION [from BASE-OBJECT] lambda function of zero arguments, or nil
If non-nil, this function gets invoked when the user clicks the object in graphics front-ends which support this functionality, e.g. SVG/Raphael and X3DOM.

ROOT [from VANILLA-MIXIN] gdl instance*
The root-level node in this object's ``tree'' (instance hierarchy).

SAFE-CHILDREN [from VANILLA-MIXIN] list of gdl instances*
All objects from the :objects specification, including elements of sequences as flat lists. Any children which throw errors come back as a plist with error information

START 3d-point
Start of the text. Specify this or center, not both.

START-LINE-INDEX number
The line number to start

STRINGS-FOR-DISPLAY [from VANILLA-MIXIN] string or list of strings*
Determines how the name of objects of this type will be printed in most places. This defaults to the name-for-display (generally the part's name as specified in its parent), followed by an index number if the part is an element of a sequence.

VISIBLE-CHILDREN [from VANILLA-MIXIN] list of gdl instances*
Additional objects to display in Tatu tree. Typically this would be a subset of hidden-children. Defaults to NIL.

Input Slots (optional, defaulting)

DISPLAY-CONTROLS [from BASE-OBJECT] plist
May contain keywords and values indicating display characteristics for this object. The following keywords are recognized currently: :color color keyword from the color-table parameter, or an HTML-style hexidecimal RGB string value, e.g. "#FFFFFF" for pure white. Defaults to :black. :line-thickness an integer, defaulting to 1, indicating relative line thickness for wireframe representations of this object. :dash-pattern (currently PDF/PNG/JPEG only). This is a list of two or three numbers which indicate the length, in pixels, of the dashes and blank spaces in a dashed line. The optional third number indicates how far into the line or curve to start the dash pattern.

HEIGHT [from BASE-OBJECT] number
Z-axis dimension of the reference box. Defaults to zero.

ORIENTATION [from BASE-OBJECT] 3x3 matrix of double-float numbers
Indicates the absolute Rotation Matrix used to create the coordinate system of this object. This matrix is given in absolute terms (i.e. with respect to the root's orientation), and is generally created with the alignment function. It should be an orthonormal matrix, meaning each row is a vector with a magnitude of one (1.0).

WIDTH [from BASE-OBJECT] number
X-axis dimension of the reference box. Defaults to zero.

Computed Slots

LENGTH-DEFAULT number
The computed length which will exactly fit the content based on (the width).

LINES list of typeset line objects
The list of lines in the nominal block.

Package Documentation