GendL Application

Object: CYLINDER (The :GEOM-BASE Package)

Mixins: IFS-OUTPUT-MIXIN, ARCOID-MIXIN, BASE-OBJECT

Description

An extrusion of circular cross section in which the centers of the circles all lie on a single line (i.e., a right circular cylinder). Partial cylinders and hollow cylinders are supported.

Input Slots (required)

LENGTH number
Distance from center of start cap to center of end cap.

RADIUS number
Radius of the circular cross section of the cylinder.

Input Slots (optional)

BOTTOM-CAP? boolean
Determines whether to include bottom cap in shaded renderings. Defaults to T.

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.

CLOSED? boolean
Indicates that a partial cylinder (or cone) should have a closed gap.

END-ANGLE [from ARCOID-MIXIN] angle in radians
End angle of the arc. Defaults to twice pi.

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

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

INNER-RADIUS number
Radius of the hollow inner portion for a hollow cylinder.

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.

NUMBER-OF-SECTIONS integer
Number of vertical sections to be drawn in wireframe rendering mode.

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-ANGLE [from ARCOID-MIXIN] angle in radians
Start angle of the arc. Defaults to zero.

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.

TOP-CAP? boolean
Determines whether to include bottom cap in shaded renderings. Defaults to T.

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.

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

Input Slots (optional, defaulting)

CENTER [from BASE-OBJECT] 3d point
Indicates in global coordinates where the center of the reference box of this object should be located.

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.

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).

Computed Slots

DIRECTION-VECTOR 3d vector
Points from the start to the end.

END 3d point
The center of the end cap.

HOLLOW? boolean
Indicates whether there is an inner-radius and thus the cylinder is hollow.

START 3d point
The center of the start cap.

Examples


 (in-package :gdl-user)

 (define-object cylinder-sample (cylinder)
   :computed-slots
   ((display-controls (list :color :pink-spicy))
    (length 10)
    (radius 3)
    (number-of-sections 25)))


 (generate-sample-drawing :objects (make-object 'cylinder-sample)
                          :projection-direction (getf *standard-views* :trimetric))

Package Documentation