Package Documentation

Object: step-reader (The :surf Package)
Mixins: base-object

Description

This object will reflect the contents of a STEP file containing points, curves, surfaces, and/or trimmed surfaces as sequences of GDL objects. Currently all surfaces are treated as trimmed, where actual untrimmed surfaces have their natural outer boundaries as the result-island, i.e. no standalone surfaces will be produced by this part. This is a default option in the HarmonyWare STEP Translator which will be exposed in GDL in a future release. The HarmonyWare reader creates a log file in a temporary directory. The location of this log file is printed on the console during the reading operation. Currently this log file is not automatically deleted, and its name is determined by the system.


Input Slots (required)

file-name string or pathname

The location of the STEP file to be read.



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.


group-trimmed-surfaces-into-brep? boolean

If true, group all trimmed surfaces in the file into one B-rep. If some trimmed surfaces are blanked, they are grouped into a second, blanked B-rep. Default is nil.


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


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.


make-all-surfaces-trimmed? boolean

If true, treat all untrimmed surfaces in the file as if they are trimmed surfaces with the natural outer boundary of the surface as the trimming loop. If used, no standalone IwSurface surface objects will ever be returned by the reader. Default is nil.


make-single-brep? boolean

If true, group all trimmed surfaces and B-reps in the file into one B-rep. If some trimmed surfaces or B-reps are blanked, they are grouped into a second, blanked B-rep. Default is nil.


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 may or may not support this functionality (see viewport-html-div).


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


sew-brep-faces? boolean

Indicates whether each resulting brep should have its faces sewn together. Default is (the make-single-brep?).


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)

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.


height [from base-object] number

Z-axis dimension of the reference box. Defaults to zero.


length [from base-object] number

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



Objects (sequence)

breps sequence of gdl brep objects

The breps and trimmed surfaces (represented as breps) found in the STEP file.


curves sequence of gdl curve objects

The curves found in the STEP file.


points sequence of gdl point objects

The points found in the STEP file.


surfaces sequence of gdl surface objects

The untrimmed ``standalone'' surfaces found in the STEP file.


Package Documentation