%

Start a "/bin/sh" shell process for the user. The mged prompt will be replaced by a system prompt for the shell, and the user may perform any legal shell commands. The mged process waits for the shell process to finish, which occurs when the user exits the shell. This only works in a command window associated with a tty (i.e., the window used to start mged in classic mode).

Examples:

mged> %

-- Start a new shell process.

3ptarb [ arb_name x1 y1 z1 x2 y2 z2 x3 y3 z3 x|y|z coord1 coord2 thickness]

Build an ARB8 shape by extruding a quadrilateral through a given thickness. The arguments may be provided on the command line; if they are not, they will be prompted for. The x1, y1, and z1 are the coordinates of one corner of the quadrilateral. x2, y2, z2, and x3, y3, z3 are the coordinates of two other corners. Only two coordinates of the fourth point are specified, and the code calculates the third coordinate to ensure all four points are coplanar. The x|y|z parameter indicates which coordinate of the fourth point will be calculated by the code. The coord1 and coord2 parameters supply the other two coordinates. The direction of extrusion for the quadrilateral is determined from the order of the four resulting points by the right-hand rule; the quadrilateral is extruded toward a viewer for whom the points appear in counter-clockwise order.

Examples:

mged> 3ptarb

-- Start the 3ptarb command.

?

Provide a list of available mged commands. The ?devel, ?lib, help, helpdevel, and helplib commands provide additional information on available commands.

Examples:

mged> ?

-- Get a list of available commands.

?devel

Provide a list of available mged developer commands. The ?, ?lib, help, helpdevel, and helplib commands provide additional information on available commands.

Examples:

mged> ?devel

-- Get a list of available developer commands.

 

?lib

Provide a list of available BRL-CAD library interface commands. The ?, ?devel, help, helpdevel, and helplib commands provide additional information on available commands.

Examples:

mged> ?lib

-- Get a list of available BRL-CAD library interface commands.

B [-R -A -o -s C#/#/#] <objects | attribute name/value pairs>

Clear the mged display of any currently displayed objects, then display the list of objects provided in the parameter list. Equivalent to the Z command followed by the command draw <objects>. The -C option provides the user a way to specify a color that overrides all other color specifications including combination colors and region id-based colors. The -A and -o options allow the user to select objects by attribute. The -s option specifies that subtracted and intersected objects should be drawn with solid lines rather than dot-dash lines. The -R option means do not automatically resize the view if no other objects are displayed. See the draw command for a detailed description of the options.

Examples:

mged> B some_object

E [-s] <objects>

Display objects in an evaluated form. All the Boolean operations indicated in each object in objects will be performed, and a resulting faceted approximation of the actual objects will be displayed. Note that this is usually much slower than using the usual draw command. The -s option provides a more accurate, but slower, approximation.

Examples:

mged> E some_object

M 1|0 xpos ypos

Send an mged mouse (i.e., defaults to a middle mouse button) event. The first argument indicates whether the event should be a button press (1) or release (0). The xpos and ypos arguments specify the mouse position in mged screen coordinates between -2047 and +2047. With the default bindings, an mged mouse event while in the viewing mode moves the view so that the point currently at screen position (xpos, ypos) is repositioned to the center of the mged display (compare to the center command). The M command may also be used in other editing modes to simulate an mged mouse event.

Examples:

mged> M 1 100 100

Z

Zap (i.e., clear) the mged display.

Examples:

mged> Z

-- Clear the mged display.

adc [-i ] [subcommand]

This command controls the angle/distance cursor. The adc command with no arguments toggles the display of the angle/distance cursor (ADC). The -i option, if specified, causes the given value(s) to be treated as increments. Note that the -i option is ignored when getting values or when used with subcommands where this option makes no sense. You can also control the position, angles, and radius of the ADC using a knob or the knob command. This command accepts the following subcommands:

vars

Returns a list of all ADC variables and their values (i.e., var = val).

draw [0|1]

Set or get the draw parameter.

a1 [angle]

Set or get angle1 in degrees.

a2 [angle]

Set or get angle2 in degrees.

dst [distance]

Set or get radius (distance) of tick in local units.

odst [distance]

Set or get radius (distance) of tick (+-2047).

hv [position]

Set or get position (grid coordinates and local units).

xyz [position]

Set or get position (model coordinates and local units).

x [xpos]

Set or get horizontal position (+-2047).

y [ypos]

Set or get vertical position (+-2047).

dh distance

Add to horizontal position (grid coordinates and local units).

dv distance

Add to vertical position (grid coordinates and local units).

dx distance

Add to x position (model coordinates and local units).

dy distance

Add to y position (model coordinates and local units).

dz distance

Add to z position (model coordinates and local units).

anchor_pos [0|1]

Anchor ADC to current position in model coordinates.

anchor_a1 [0|1]

Anchor angle1 to go through anchorpoint_a1.

anchor_a2 [0|1]

Anchor angle2 to go through anchorpoint_a2.

anchor_dst [0|1]

Anchor tick distance to go through anchorpoint_dst.

anchorpoint_a1 [x y z]

Set or get anchor point for angle1 (model coordinates and local units).

anchorpoint_a2 [x y z]

Set or get anchor point for angle2 (model coordinates and local units).

anchorpoint_dst [x y z]

Set or get anchor point for tick distance (model coordinates and local units).

reset

Reset all values to their defaults.

help

Print the help message.

Examples:

mged> adc

-- Toggle display of the angle/distance cursor

ae [-i] azimuth elevation [twist]

Set the view orientation for the mged display by rotating the eye position about the center of the viewing cube. The eye position is determined by the supplied azimuth and elevation angles (degrees). The azimuth angle is measured in the xy plane with the positive x direction corresponding to an azimuth of 0˚. Positive azimuth angles are measured counter-clockwise about the positive z axis. Elevation angles are measured from the xy plane with +90˚ corresponding to the positive z direction and -90 corresponding to the negative z direction. If an optional twist angle is included, the view will be rotated about the viewing direction by the specified twist angle. The -i option results in the angles supplied being interpreted as increments.

Examples:

mged> ae -90 90

-- View from top direction.

analyze [arb_name]

The "analyze" command displays the rotation and fallback angles, surface area, and plane equation for each face of the ARB specified on the command line. The total surface area and volume and the length of each edge are also displayed. If executed while editing an ARB, the arb_name may be omitted, and the ARB being edited will be analyzed.

Examples:

mged> analyze arb_name

-- Analyze the ARB named arb_name.

animmate

The "animmate" command starts the Tcl/Tk-based animation tool. The capabilities and correct use of this command are too extensive to be described here, but there is a tutorial available.

apropos keyword

The "apropos" command searches through the one-line usage messages for each mged command and displays the name of each command where a match is found.

 

Examples:

mged> apropos region

-- List all commands that contain the word "region" in their one-line usage messages.

aproposdevel keyword

The "aproposdevel" command searches through the one-line usage messages for each mged developer command and displays the name of each command where a match is found.

Examples:

mged> aproposdevel region

aproposlib keyword

The "aproposlib" command searches through the one-line usage messages for each BRL-CAD library interface command and displays the name of each command where a match is found.

Examples:

mged> aproposlib mat

-- List all commands that contain the word "mat" in their one-line usage messages.

arb arb_name rotation fallback

The "arb" command creates a new ARB shape with the specified arb_name. The new ARB will be 20 inches by 20 inches and 2 inches thick. The square faces will be perpendicular to the direction defined by the rotation and fallback angles. This direction can be determined by interpreting the rotation angle as an azimuth and the fallback angle as an elevation as in the ae command.

Examples:

mged> arb new_arb 35 25

-- Create new_arb with a rotation angle of 35˚ and a fallback angle of 25˚.

mged> ae 35 25
-- Rotate view to look straight on at square face of new_arb

arced comb/memb anim_command

The objects in a BRL-CAD model are stored as Boolean combinations of primitive shapes and/or other combinations. These combinations are stored as Boolean trees, with each leaf of the tree including a corresponding transformation matrix. The "arced" command provides a means for directly editing these matrices. The first argument to the "arced" command must identify the combination and which member�s matrix is to be edited. The comb/memb argument indicates that member memb of combination comb has the matrix to be edited. The remainder of the "arced" command line consists of an animation command to be applied to that matrix. The available animation commands are:

• matrix rarc <xlate|rot> matrix elements
  -- Replace the members matrix with the given matrix.
• matrix lmul <xlate|ro> matrix elements .
  -- Left multiply the members matrix with the given matrix.
• matrix rmul <xlate|rot> matrix elements.
  -- Right multiply the members matrix with the given matrix.
  

Examples:

mged> arced body/head matrix rot 0 0 45

area [tolerance]

The "area" command calculates an approximate presented area of one region in the mged display. For this command to work properly, a single BRL-CAD region must be displayed using the E command. The tolerance is the distance required between two vertices in order for them to be recognized as distinct vertices. This calculation considers only the minimum bounding polygon of the region and ignores holes.

Examples:

mged> Z

-- Clear the mged display(s).

arot x y z angle

The "arot" command performs a rotation about the specified axis (x y z) using screen units (-2048 to +2048). The amount of rotation is determined by angle, which is in degrees. Exactly what is rotated and how it is rotated are dependent on MGED�s state as well as the state of the display manager. For example, in normal viewing mode, this command simply rotates the view. However, in primitive edit mode, it rotates the shape being edited.

Examples:

mged> arot 0 0 1 10

-- Rotate 10 degrees about z axis.

attach [-d display_string] [-i init_script] [-n name] [-t is_toplevel] [-W width] [-N height] [-S square_size] win_type

The "attach" command is used to open a display window. The set of supported window types includes X and ogl. It should be noted that attach no longer releases previously attached display windows (i.e., multiple attaches are supported). To destroy a display window, use the release command.

Examples:

mged> attach ogl

attr get|set|rm|append|show object_name [arguments]

The "attr" command is used to create, change, retrieve, or view attributes of database

objects. The arguments for "set" and "append" subcommands are attribute name/value pairs. The arguments for "get," "rm," and "show" subcommands are attribute names. The "set" subcommand sets the specified attributes for the object. The "append" subcommand appends the provided value to an existing attribute, or creates a new attribute if it does not already exist. The "get" subcommand retrieves and displays the specified attributes. The "rm" subcommand deletes the specified attributes. The "show" subcommand does a "get" and displays the results in a user readable format. Note that the attribute names may not contain embedded white space, and if attribute values contain embedded white space, they must be surrounded by "{}" or double quotes.

Examples:

mged> attr set region_1 comment {This is a comment for region_1}

-- Assign an attribute named "comment" to region_1, its value is "This is a

comment for region_1"

mged> attr show region_1 comment

-- List all the attributes for region_1

---

autoview

The "autoview" command resets the view size and the view center such that all displayed objects are within the view.

Examples:

mged> autoview

-- Adjust the view to see everything displayed.

---

bev [-t] [-P#] new_obj Boolean_formula

The "bev" command performs the operations indicated in the Boolean_formula and stores the result in new_obj. The new_obj will be stored as an NMG shape (it may be converted to a polysolid by using the nmg_simplify command). If the -t option is specified, then the resulting object will consist entirely of triangular facets. The default is to allow facets of any complexity, including holes. The -P option specifies the number of CPUs to use for the calculation (however, this is currently ignored). Only simple Boolean_formulas are allowed. No parentheses are allowed and the operations are performed from left to right with no precedence. More complex expressions must be expressed as BRL-CAD objects using the r, g, or c commands and evaluated using the facetize or ev commands.

Examples:

mged> bev -t triangulated_lens sphere1 + sphere2

-- Create a triangulated object by intersecting objects sphere1 and sphere2.

bo [-o|-i pattern type] dest source

The "bo" command is used to create or retrieve binary opaque objects. One of -i or -o must be specified.

The -o option "outputs" or extracts a binary object from the database object source to a file called dest.

The -i option "inputs" or imports a file called source into a binary object called dest in the database. There are two additional arguments that must be specified with the -i option: pattern and type. Currently, only uniform binary objects (arrays of values) are supported. As a result, the pattern is always u for "uniform" pattern. The type can be one of the following:

f -> float

d -> double

c -> char (8 bit)

s -> short (16 bit)

i -> int (32 bit)

l -> long (64 bit)

C -> unsigned char (8 bit)

S -> unsigned short (16 bit)

I -> unsigned int (32 bit)

L -> unsigned long (64 bit)

Examples:

mged> bo -i -u c cmds /usr/brlcad/html/manuals/mged/mged_cmd_index.html

-- Create an opaque uniform binary object of characters with the name cmds that contains the contents of the file /usr/brlcad/html/manuals/mged/mged_cmd_index.html.

mged> bo -o /home/jim/cmds.html cmds

-- Copy the contents of the binary object named cmds into the file named /home/jim/cmds.html.

bot_condense new_bot_primitive old_bot_primitive

The "bot_condense" command is used to eliminate unused vertices from a BOT primitive. It returns the number of vertices eliminated.

Examples:

mged> bot_condense bot1_condensed bot1_original

-- Eliminate any unused vertices from the primitive named bot1_original and store the result in the new BOT primitive named bot1_condensed.

---

bot_decimate �c maximum_chord_error �n maximum_normal_error �e minimum_edge_length new_bot_primitive old_bot_primitive

The "bot_decimate" command reduces the number of triangles in the old_bot_primitive and saves the results to the new_bot_primitive. The reduction is accomplished through an edge decimation algorithm. Only changes that do not violate the specified constraints are performed. The maximum_chord_error parameter specifies the maximum distance allowed between the original surface and the surface of the new BOT primitive in the current editing units. The maximum_normal_error specifies the maximum change in surface normal (degrees) between the old and new surfaces. The minimum_edge_length specifies the length of the longest edge that will be decimated. At least one constraint must be supplied. If more than one constraint is specified, then only operations that satisfy all the constraints are performed.

Examples:

mged> bot_decimate -c 0.5 -n 10.0 bot.new abot

-- Create a new BOT primitive named bot.new by reducing the number of triangles

in abot while keeping the resulting surface within 0.5 units of the surface of abot and

keeping the surface normals within 10 degrees.

Note that the constraints specified only relate the output BOT primitive to the input

BOT primitive for a single invocation of the command. Repeated application of this

command on its own BOT output will result in a final BOT primitive that has

unknown relationships to the original BOT primitive. For example:

mged> bot_decimate -c 10.0 bot_b bot_a

mged> bot_decimate -c 10.0 bot_c bot_b

-- This sequence of commands will produce primitive "bot_c" with up to 20.0 units

of chord error between "bot_a" and "bot_c".

mged> bot_decimate -c 10.0 bot_b bot_a

mged> bot_decimate -n 5.0 bot_c bot_b

-- This sequence of commands will produce primitive "bot_c" with no guaranteed

relationships to "bot_a".

---

bot_face_fuse new_bot_primitive old_bot_primitive

The "bot_face_fuse" command is used to eliminate duplicate faces from a BOT solid. It returns the number of faces eliminated.

Examples:

mged> bot_face_fuse bot1_fused bot1_original

-- Eliminate any duplicate faces from the primitive named bot1_original and store the result in the new BOT primitive named bot1_fused.

---

bot_face_sort triangles_per_piece bot_primitive1 [bot_primitive2 bot_primitive3 ...]

The "bot_face_sort" command is used to sort the list of triangles that constitutes the BOT primitive to optimize it for raytracing with the specified number of triangles per piece. Most BRL-CAD primitives are treated as a single object when a model is being prepared for raytracing, but BOT primitives are normally broken into "pieces" to improve performance. The raytracer normally uses four triangles per piece.

Examples:

mged> bot_face_sort 4 bot1 bot2

-- Sort the faces of bot1 and bot2 to optimize them for raytracing with four triangles per piece.

---

bot_vertex_fuse new_bot_solid old_bot_primitive

The "bot_vertex_fuse" command is used to eliminate duplicate vertices from a BOT solid. It returns the number of vertices eliminated. No tolerance is used, so the vertices must match exactly to be considered duplicates.

Examples:

mged> bot_vertex_fuse bot1_fused bot1_original

-- Eliminate any duplicate vertices from the primitive named bot1_original and store the result in the new BOT primitive named bot1_fused.

---

build_region [-a region_num] tag start_num end_num

The "build_region" command builds a region from existing solids that have specifically formatted names based on the provided tags and numbers. The created region will be named "tag.rx", where "x" is the first number (starting from 1) that produces an unused region name. If the -a option is used, then the specified "region_num" will be used for "x." If that region already exists, this operation will append to it. If that region does not exist, a new one will be created. The solids that will be involved in this operation are those with names of the form "tag.s#" or "tag.s#o@", where "#" is a number between start_num and end_num inclusive, "o" is either "u", "-", or "+", and "@" is any number. The operators and numbers coded into the solid names are used to build the region.

Examples:

mged> build_region abc 1 2

-- Creates a region named "abc.r1" consisting of:

u abc.s1

u abc.s2

+ abc.s2+1

- abc.s2-1

provided that the above shapes already exist in the database.

---

c [-c|r] combination_name [Boolean_expression]

The "c" command creates a BRL-CAD combination with the name combination_name. The -r option indicates that the combination is a BRL-CAD region. The -c option is the default and indicates that the combination is not a region. The Boolean_expression allows parentheses. Where no order is specified, intersections are performed before subtractions or unions; then subtractions and unions are performed, left to right. Where there is no Boolean_expression and combination_name, a new empty combination will be created. If no Boolean_expression is provided, and combination_name does already exist and one of -c or -r is specified, then combination_name is flagged to agree with the indicated option. If a new region is created or an existing combination is flagged as a region with this command, its region-specific attributes will be set according to the current defaults (see regdef). The comb and r commands may also be used to create combinations.

Examples:

mged> c -c abc (a u b) - (a + d)

-- Create a combination named abc according to the formula (a u b) - (a + d).

cat <objects>

The "cat" command displays a brief description of each item in the list of objects. If the item is a primitive shape, the type of shape and its vertex are displayed. If the item is a combination, the Boolean formula for that combination�including operands, operators, and parentheses�is displayed. If the combination is flagged as a region, then that fact is also displayed along with the region�s ident code, air code, los, and GIFT material code.

Examples:

mged> cat region_1 region_2

-- Display the Boolean formulas for some regions.

center [x y z]

The "center" command positions the center of the mged viewing cube at the specified model coordinates. This is accomplished by moving the eye position while not changing the viewing direction. (The lookat command performs a related function by changing the viewing direction, but not moving the eye location.) The coordinates are expected in the current editing units. In case the coordinates are the result of evaluating a formula, they are echoed back. If no coordinates are provided, the current center coordinates (in current editing units, not mm) are printed and can be used in subsequent calculations.

Examples:

mged> center

-- Print out the coordinates of the center of the mged display.

mged> center 12.5 5.6 8.7

-- Move the center of the mged display to the point (12.5, 5.6, 8.7).

mged> set oldcent [center]
-- Set the Tcl variable $oldcent to the display center coordinates.

mged> set glob_compat_mode 0

mged> units mm

mged> eval center [vadd2 [center] {2 0 0}]
-- Move the center point two mm in the model + x direction.

mged> units mm

check {subcommand}[options][objects...]

The "check" command computes and reports a variety of characteristics of the objects specified from the opened database. The characteristics which can be computed include mass, centroid, moments of inertia, volume, overlaps, surface area, exposed air, gaps/voids, adjacent air and unconfined air. Only the objects from the database specified on the command line are analyzed. The following are the sub-commands offered:

adj_air

Detects air volumes which are next to each other but have different air_code values applied to the region.

centroid

Computes the centroid of the objects specified.

exp_air

Check if the ray encounters air regions before (or after all) solid objects.

gap

This reports when there is more than overlap tolerance distance between objects on the ray path.

mass

Computes the mass of the objects specified.

moments

Computes the moments and products of inertia of the objects specified.

overlaps

This reports overlaps, when two regions occupy the same space.

surf_area

Computes the surface area of the objects specified.

unconf_air

This reports when there are unconfined air regions.

volume

Computes the volume of the objects specified.

The following are the options offered by the check command:

• a #[deg|rad] -- Select azimuth in degrees with an implicit "deg" suffix and in radians with an explicit "rad" suffix. Used with -e. Default value is 35 degrees.
• e #[deg|rad] -- Select elevation in degrees with an implicit "deg" suffix and in radians with an explicit "rad" suffix.Used with -a. Default value is 25 degrees.
• d -- Set debug flag.
• f filename -- Specifies that density values should be taken from an external file instead of from the _DENSITIES object in the database.
• g [initial_grid_spacing-]grid_spacing_limit or [initial_grid_spacing,]grid_spacing_limit -- Specifies a limit on how far the grid can be refined and optionally the initial spacing between rays in the grids.
• -G [grid_width,]grid_height -- sets the grid size, if only grid width is mentioned then a square grid size is set.
• i -- gets 'view information' from the view to setup eye position.
• M # --Specifies a mass tolerance value.
• n # -- Specifies that the grid be refined until each region has at least num_hits ray intersections.
• N # -- Specifies that only the first num_views should be computed.
• o -- Specifies to display the overlaps as overlays.
• p -- Specifies to produce plot files for each of the analyses it performs.
• P # -- Specifies that ncpu CPUs should be used for performing the calculation. By default, all local CPUs are utilized.
• q -- Quiets (suppresses) the 'was not hit' reporting.
• r -- Indicates to print per-region statistics for mass/volume/surf_area as well as the values for the objects specified.
• R -- Disable reporting of overlaps.
• s # -- Specifies surface area tolerance value.
• S # -- Specifies that the grid spacing will be initially refined so that at least samples_per_axis_min will be shot along each axis of the bounding box of the model.
• t # -- Sets the tolerance for computing overlaps.
• u distance_units,volume_units,mass_units -- Specify the units used when reporting values.
• U # -- Specifies the Boolean value (0 or 1) for use_air which indicates whether regions which are marked as 'air' should be retained and included in the raytrace.
• v -- Set verbose flag.
• V # -- Specifies a volumetric tolerance value.

Examples:

mged> check overlaps -g10,10 box

color low high r g b str

The "color" command creates an entry in the database that functions as part of a color lookup table for displayed regions. The ident number for the region is used to find the appropriate color from the lookup table. The low and high values are the limits of region ident numbers to have the indicated rgb color (0-255) applied. The str parameter is intended to be an identifying character string, but is currently ignored. The current list of color table entries may be displayed with the prcolor command, and the entire color table may be edited using the edcolor command. If a color lookup table exists, its entries will override any color assigned using the mater command.

Examples:

mged> color 1100 1200 255 0 0 fake_string

comb combination_name <operation object>

The "comb" command creates a new combination or extends an existing one. If combination_name does not already exist, then it will be created using the indicated list of operations and objects. If it does exist, the list of operations and objects will be appended to the end of the existing combination. The <operation object> list is expected to be in the same form as used in the r command. The c command may also be used to create a combination.

Examples:

mged> comb abc u a - b + c

-- Create combination abc as ((a - b) + c).

comb_color combination_name r g b

The "comb_color" command assigns the color rgb (0-255) to the existing combination named combination_name.

Examples:

mged> comb_color region1 0 255 0

-- Assign the color green to region1.

copyeval new_primitive path_to_old_ primitive

Objects in a BRL-CAD model are stored as Boolean trees (combinations), with the members being primitive shapes or other Boolean trees. Each member has a transformation matrix associated with it. This arrangement allows a primitive to be a member of a combination, and that combination may be a member of another combination, and so on. When a combination is displayed, the transformation matrices are applied to its members and passed down through the combinations to the leaf (primitive shape) level. The accumulated transformation matrix is then applied to the primitive before it is drawn on the screen. The "copyeval" command creates a new primitive object called new_ primitive by applying the transformation matrices accumulated along the path_to_old_primitive to the leaf primitive shape object at the end of the path and saving the result under the name new_ primitive. The path_to_old_ primitive must be a legitimate path ending with a primitive shape.

Examples:

mged> copyeval shapeb comb1/comb2/comb3/shapea

copymat comb1/memb1 comb2/memb2

The "copymat" command copies the transformation matrix from a member of one combination to the member of another.

Examples:

mged> copymat comb1/memb1 comb2/memb2

cp from_object to_object

The "cp" command makes a duplicate of an object (shape or combination). If from_object is a shape, then it is simply copied to a new shape named to_object. If from_object is a combination, then a new combination is created that contains exactly the same members, transformation matrices, etc., and it is named to_object.

Examples:

mged> cp comb1 comb2

-- Make a duplicate of combination comb1 and call it comb2.

cpi old_tgc new_tgc

The "cpi" command copies old_tgc (an existing TGC shape) to a new TGC shape (new_tgc), positions the new TGC such that its base vertex is coincident with the center of the top of old_tgc, and puts mged into the primitive edit state with new_tgc selected for editing. This command was typically used in creating models of wiring or piping runs; however, a pipe primitive has since been added to BRL-CAD to handle such requirements.

Examples:

mged> cpi tgc_a tgc_b

-- Copy tgc_a to tgc_b and translate tgc_b to the end of tgc_a.

d <objects>

The "d" command deletes the specified list of objects from the mged display. This is a synonym for the erase command. Only objects that have been explicitly displayed may be deleted with the "d" command (use the who command to see a list of explicitly displayed objects). Objects that are displayed as members of explicitly displayed combinations cannot be deleted from the display with this command (see erase -r). Note that this has no effect on the BRL-CAD database itself. To actually remove objects from the database, use the kill command.

Examples:

mged> d region1 shapea

-- Delete region1 and shapea from the mged display.

db command [args...]

The "db" command provides an interface to a number of database manipulation routines. Note that this command always operates in units of millimeters. The command must be one of the following with appropriate arguments:

• match <regular_exp>
  -- Return a list of all objects in that database that match the list of regular expressions.
• get shape_or_path [attribute]
  -- Return information about the primitive shape at the end of the shape_or_path. If a path is specified, the transformation matrices encountered along that path will be accumulated and applied to the leaf shape before displaying the information. If no attribute is specified, all the details about the shape are returned. If a specific attribute is listed, then only that information is returned.
• put shape_name shape_type attributes
  -- Create shape named shape_name of type shape_type with attributes as listed in attributes. The arguments to the put command are the same as those returned by the get command.
• adjust shape_name attribute new_value1 [new_value2 new_value3...]
  -- Modify the shape named shape_name by adjusting the value of its attribute to the new_values.
• form object_type
  -- Display the format used to display objects of type object_type.
• tops
  -- Return all top-level objects.
• close
  -- Close the previously opened database and delete the associated command.

Examples:

mged> db match *.s

-- Get a list of all objects in the database that end with ".s".

db_glob cmd_string

Globs cmd_string against the MGED database resulting in an expanded command string.

Examples:

mged> db_glob "l r23\[0-9\]"

dbconcat [-s/-p] [-t] [-u] [-c] database_file [affix]

The "dbconcat" command concatenates an existing BRL-CAD database to the database currently being edited. If an affix is supplied, then all objects from the database_file will have that affix added to their names. The -s option indicates that the affix is a suffix, while the -p option (default) indicates that the affix is a prefix. Note that each BRL-CAD object must have a unique name, so care must be taken not to "dbconcat" a database that has objects with names the same as objects in the current database. The dup command may be used to check for duplicate names. If the dup command finds duplicate names, use the prefix option to both the dup and dbconcat commands to find a prefix that produces no duplicates. If duplicate names are encountered during the "dbconcat" process, and no affix is supplied, computer-generated prefixes will be added to the object names coming from the database_file (but member names appearing in combinations will not be modified, so this is a dangerous practice and should be avoided). If the -t option is specified, then the title of the database_file will become the new title of the current BRL-CAD database. If the -u option is specified, the units of the current database will be set to that of the database_file being concatted. The -c option specifies that the region color table in the concatted database_file should replace any region color table in the current BRL-CAD database.

Examples:

mged> dbconcat model_two.g two_

-- Copy all the objects in model_two.g to the current database, but prefix the name of every object copied with the string two_.

mged> dbconcat -s model_two.g

-- Copy all the objects in model_two.g to the current database, adding computer-generated suffixes as required.

mged> dbconcat -c -p model_two.g two_

-- Copy all the objects in model_two.g to the current database, adding the prefix two_ to every object copied from model_two.g. The region color table from model_two.g is copied to the current database, and any region color table that had existed in the current database is deleted.

debugbu [hex_code]

The "debugbu" command allows the user to set or check the debug flags used by libbu. With no arguments, the debugbu command displays all the possible settings for the bu_debug flag and the current value. When a hex_code is supplied, that value is used as the new value for bu_debug. Similar debug commands for other BRL-CAD libraries are debuglib for librt and debugnmg for the NMG portion of librt.

Examples:

mged> debugbu

-- Get a list of available bu_debug values and the current value.

---

debugdir

The "debugdir" command displays a dump of the in-memory directory for the current database file. The information listed for each directory entry includes:

• memory address of the directory structure.
• name of the object.
• "d_addr" for objects on disk, or "ptr" for objects in memory.
• "SOL," "REG," or "COM" if the object is a shape, region, or combination, respectively.
• file offset (for objects on disk) or memory pointer (for objects in memory).
• number of instances referencing this object (not normally filled in).
• number of database granules used by this object.
• number of times this object is used as a member in combinations (not normally filled in).

Examples:

mged> debugdir

-- Get a dump of the in-memory directory.

debuglib [hex_code]

The "debuglib" command allows the user to set or check the debug flags used by librt. With no arguments, the debuglib command displays all the possible settings for the librt debug flag and the current value. When a hex_code is supplied, that value is used as the new value for the flag. Similar debug commands for other BRL-CAD libraries are debugbu for libbu and debugnmg for the NMG portion of librt.

Examples:

mged> debuglib

-- Get a list of available debug values for librt and the current value.

debugnmg [hex_code]

The "debugnmg" command with no options displays a list of all possible debug flags available for NMG processing. If the command is invoked with a hex number argument, that value is used as the new value for the NMG debug flag. Similar debug commands for other BRL-CAD libraries are debuglib for librt and debugbu for libbu.

Examples:

mged> debugnmg 100

-- Set the NMG debug flag to get details on the classification process.

decompose NMG_shape [prefix]

The "decompose" command processes an NMG shape and produces a series of new NMG shapes consisting of each maximally connected shell in the original NMG shape. If an optional prefix is supplied, the resulting NMG shapes will be named by using the prefix and adding an underscore character and a number to make the name unique. If no prefix is supplied, the default prefix "sh" will be used.

Examples:

mged> decompose shape.nmg part

delay seconds microseconds

The "delay" command provides a delay of the specified time before the next command will be processed.

Examples:

mged> delay 5 0

-- Delay for 5 seconds.

dm subcommand [args]

The "dm" command provides a means to interact with the display manager at a lower level. The dm command accepts the following subcommands:

set [var [val]]

The "set" subcommand provides a means to set or query display manager-specific variables. Invoked without any arguments, the set subcommand will return a list of all available internal display manager variables. If only the var argument is specified, the value of that variable is returned. If both var and val are given, then var will be set to val.

size [width height]

The "size" subcommand provides a means to set or query the window size. If no arguments are given, the display manager�s window size is returned. If width and height are specified, the display manager makes a request to have its window resized. Note that a size request is just that, a request, so it may be ignored, especially if the user has resized the window using the mouse.

m button x y

The "m" subcommand is used to simulate an M command. The button argument determines which mouse button is being used to trigger a call to this command. This value is used in the event handler to effect dragging the faceplate scrollbars. The x and y arguments are in X screen coordinates, which are converted to MGED screen coordinates before being passed to the M command.

am <r | t | s> x y

The "am" subcommand effects mged�s alternate mouse mode. The alternate mouse mode gives the user a different way of manipulating the view or an object. For example, the user can drag an object or perhaps rotate the view while using the mouse. The first argument indicates the type of operation to perform (i.e., r for rotation, t for translation, and s for scale). The x and y arguments are in X screen coordinates and are transformed appropriately before being passed to the knob command.

adc <1 | 2 | t | d> x y

The "adc" subcommand provides a way of manipulating the angle distance cursor while using the mouse. The first argument indicates the type of operation to perform (i.e., 1 for angle 1, 2 for angle 2, t for translate, and d for tick distance). The x and y arguments are in X screen coordinates and are transformed appropriately before being passed to the adc command (i.e., not "dm adc").

con <r | t | s <x | y | z> xpos ypos

This form of the "con" subcommand provides a way to effect constrained manipulation of the view or an object while using the mouse. This simulates the behavior of sliders without taking up screen real estate. The first argument indicates the type of operation to perform (i.e., r for rotation, t for translation, and s for scale). The <x | y | z> argument is the axis of rotation, translation, or scale. The xpos and ypos arguments are in X screen coordinates and are transformed appropriately before being passed to the knob command.

con a <x | y | 1 | 2 | d> xpos ypos

This form of the "con" subcommand provides a way to effect constrained manipulation of the angle distance cursor while using the mouse. This simulates the behavior of sliders without taking up screen real estate. The first argument indicates that this is to be applied to the angle distance cursor. The next argument indicates the type of operation to perform (i.e., x for translate in the x direction, y for translate in the y direction, 1 for angle 1, 2 for angle 2, and d for tick distance). The xpos and ypos arguments are in x screen coordinates and are transformed appropriately before being passed to the knob command.

Examples:

mged> dm set

-- Get a list of the available display manager internal variables.

draw [-R -A -s -o -C#/#/#] <objects | attribute name/value pairs>

Add <objects> to the display list so that they will appear on the MGED display. The e command is a synonym for draw.

• The -C option provides the user a way to specify a color that overrides all other color specifications including combination colors and region-id-based colors.
• The -s option specifies that subtracted and intersected objects should be drawn with shape lines rather than dot-dash lines.
• The -A option specifies that the arguments provided to this command are attribute name/value pairs, and only objects having the specified attributes and values are to be displayed. The default (without -o) is that only objects having all the specified attribute name/value pairs will be displayed.

Examples:

mged> draw object1 object2

-- Draw object1 and object2 in the MGED display.

mged> draw -C 255/255/255 object2

-- Draw object2 in white.

mged> draw -A -o Comment {First comment} Comment {Second comment}

dup file [prefix]

The "dup" command checks the specified file (which is expected to contain a BRL-CAD model) for names that are the same as those in the current model. If a prefix is included on the command line, all names in the specified file will have that prefix added to their names before comparison with the current model. This command is often used prior to invoking the dbconcat command to ensure that there are no name clashes.

Examples:

mged> dup other_model.g

-- Check other_model.g for names duplicating those in the current model.

e [-R -A -o -s -C#/#/#] <objects| attribute name/value pairs>

The "e" command adds the objects in the argument list to the display list so that they will appear on the MGED display. This is a synonym for the draw command; see that entry for a full list of options. The -C option provides the user a way to specify a color that overrides all other color specifications including combination colors and region-id-based colors. The -A and -o options allow the user to select objects by attribute. The -s specifies that subtracted and intersected objects should be drawn with solid lines rather than dot-dash lines. The -R option means do not automatically resize the view if no other objects are displayed.

Examples:

mged> e object1 object2

-- Draw object1 and object2 in the MGED display.

mged> e-A -o Comment {First comment} Comment {Second comment}

eac <aircodes>

The "eac" command adds all the regions in the current model that have one of the aircodes in the argument list to the display list so that they will appear on the MGED display. Regions that have nonzero ident numbers will not be listed by this command. The whichair command will perform the same search, but just lists the results.

Examples:

mged> eac 1 2 3

-- Draw all regions with aircodes 1, 2, or 3 in the MGED display.

echo text

The "echo" command merely echos whatever text is provided as an argument on the command line. This is intended for use in MGED scripts.

Examples:

mged> echo some text goes here

-- Display the text, "some text goes here."

edcodes <objects>

The "edcodes" command puts the user into an editor to edit a file that has been filled with the ident, air code, material code, LOS, and name of all the regions in the specified objects. The user may then modify the entries (except for the names). The editor used is whatever the user has set in the environment variable EDITOR. If EDITOR is not set, then /bin/ed is used.

Examples:

mged> edcodes object1 object2

-- Edit the region codes for all regions below object1 and object2.

edcolor

The "edcolor" command puts the user into an editor to edit a file that has been filled with the ident based color lookup table. The entire table may be seen with the prcolor command, and entries may be added using the color command. The editor used is whatever the user has set in the environment variable EDITOR. If EDITOR is not set, then /bin/ed is used.

Examples:

mged> edcolor

-- Edit the color table.

edcomb combname R|G regionid air_code los [material_code]

The "edcomb" command allows the user to modify the attributes of a combination. The combname is the name of the combination to be modified. An R flag indicates that the region flag should be set; otherwise, the region flag is unset. If the region flag is not being set, then the remainder of the attributes are ignored. If the region flag is being set, then the region_id, aircode, los, and material_code are set according to the arguments supplied.

Examples:

mged> edcomb comb1 R 1001 0 50 8

edgedir [x y z]|[rot fb]

The "edgedir" command allows the user to set the direction of an edge by specifying a direction vector in the form of x, y, and z components or via rotation and fallback angles. This can only be done while moving an edge of an ARB.

Examples:

mged> edgedir 0 1 0

-- Rotate the edge being edited to be parallel to the y axis.

edmater <combinations>

The "edmater" command places the user in an editor ready to edit a file filled with shader arguments for the combinations listed on the command line. The arguments placed in the file for editing are the shader name and its own arguments, RGB color, RGB_valid flag, and the inheritance flag. The editor used is whatever the user has set in the environment variable EDITOR. If EDITOR is not set, then /bin/ed is used.

Examples:

mged> edmater comb1 comb2

-- Edit the shader parameters for combinations named comb1 and comb2.

eqn A B C

The "eqn" command allows the user to rotate the face of an ARB shape by providing the coefficients of an equation of the desired plane for the face. The coefficients A, B, and C are from the plane equation:

        Ax + By + Cz = D

Examples:

mged> eqn 0 0 1

-- Rotate the face of the ARB being edited to be parallel to the xy plane.

erase <objects>

The "erase" command deletes the specified list of objects from the MGED display. This is a synonym for the d command. Only objects that have been explicitly displayed may be deleted with the "erase" command (use the who command to see a list of explicitly displayed objects). Objects that are displayed as members of explicitly displayed combinations cannot be deleted from the display with this command (see erase -r). Note that this has no effect on the BRL-CAD database itself. To actually remove objects from the database, use the kill command.

Examples:

mged> erase region1 shapea

-- Delete region1 and shapea from the MGED display.

ev [-dfnrstuvwST] [-P#] [-C#/#/#] <objects>

The "ev" command evaluates the objects specified by tessellating all primitive shapes in the objects and then performing any Boolean operations specified in the objects. The result is then displayed in the MGED display according to the specified options:

• d -- Do not perform Boolean operations or any checking; simply convert shapes to polygons and draw them. Useful for visualizing BOT and polysolid primitives.
• f -- Fast path for quickly visualizing polysolid primitives.
• w -- Draw wireframes (rather than polygons).
• n -- Draw surface normals as little "hairs."
• s -- Draw shape lines only (no dot-dash for subtract and intersect).
• t -- Perform CSG-to-tNURBS conversion (still under development).
• v -- Shade using per-vertex normals, when present.
• u -- Draw NMG edgeuses (for debugging).
• S -- Draw tNURBS with trimming curves only, no surfaces.
• T -- Do not triangulate after evaluating the Boolean (may produce unexpected results if not used with the w option).
• P# -- Use # processors in parallel. Default=1.
• r -- Draw all objects in red. Useful for examining objects colored black.
• C#/#/# -- Draw all objects in in the specified rgb color.

Examples:

mged> ev region1 shapea

-- Display evaluated region1 and shapea as shaded polygons.

exit

The "exit" command ends the MGED process. This is a synonym for the quit command.

Examples:

mged> exit

-- Stop MGED.

---

expand regular_expression

The "expand" command performs matching of the regular_expression with the names of all the objects in the database. It returns all those that successfully match.

Examples:

mged> expand *.r

-- Display a list of all database object names that end in ".r".

expand_comb prefix comb ...

The expand_comb will create a new combination object prefix. For each Boolean node in the original tree of the combination a new combination will be created. Each combination constructed will contain a single Boolean operation of two leaf nodes. The leaf nodes will be named prefixl and prefixr for the left and right nodes of the tree respectively. Sub-nodes will have "l" and "r" suffixes added based upon whether they are left or right children of the node.

Note that regions, combinations and objects created with the "g" command (sometimes colloquially referred to as groups) are all combinations, and can be expanded with this command.

Example:

mged> r foo.r u a - b + c u d + e
Defaulting item number to 1003
Creating region id=1003, air=0, GIFTmaterial=1, los=100
mged> l foo.r
foo.r:  REGION id=1003  (air=0, los=100, GIFTmater=1) --
   u a
   - b
   + c
   u d
   + e
mged> tree foo.r
foo.r/R
        u a
        - b
        + c
        u d
        + e

mged> expand_comb_tree -c foo.r
mged> l foo.r_xpand
foo.r_xpand:  REGION id=1003  (air=0, los=100, GIFTmater=1) --
   u foo.r_xpand_l
   u foo.r_xpand_r
mged> tree foo.r_xpand
foo.r_xpand/R
        u foo.r_xpand_l/R
                u foo.r_xpand_ll/R
                        u a
                        - b
                + c
        u foo.r_xpand_r/R
                u d
                + e

---

extrude #### distance

The "extrude" command modifies an ARB shape by extruding the specified face through the specified distance to determine the position of the opposing face. The face to be extruded is identified by listing its vertex numbers as they are labeled in the MGED display when the ARB is edited. Note that the face identified is not moved, but the opposite face is adjusted so that it is the specified distance from the specified face. The order that the vertex numbers are listed determines the direction of the extrusion using the right-hand rule.

Examples:

mged> extrude 1234 5

-- Move face 5678 so that it is 5 units from face 1234.

eye_pt x y z

The "eye_pt" command positions the eye point to the given x, y, and z coordinates (specified in mm).

Examples:

mged> eye_pt 100 0 0

-- Position the eye at 100 mm along the x axis.

facedef #### [a|b|c|d parameters]

The "facedef" command allows the user to redefine any face of an ARB8 shape. The user must be in Primitive Edit Mode with an ARB selected for editing. The optional parameters may be omitted, and MGED will prompt for the missing values. The options are:

• a
  -- Specify the new location of this face by providing coefficients for its plane equation:

        Ax + By + Cz = D.

• b
  -- Specify the new location of this face using three points.
• c
  -- Specify the new location of this face using rotation and fallback angles.
• d
  -- Specify the new location of this face by changing the D value in the plane equation.
• q
  -- Return to MGED prompt.

Examples:

mged> facedef 1234 a 1 0 0 20

-- Move face 1234 such that it is in the yz plane at x=20.

facetize [-ntT] [-P#] new_object old_object

The "facetize" command creates new_object as a BOT shape by tessellating all the primitive shapes in old_object and then performing any Boolean operations specified in old_object. The -T option indicates that all faces in the new_object should be triangulated. The -n option specifies that the resulting shape should be saved as an NMG shape. The -t option is to create TNURB faces rather than planar approximations (this option is still under development). The -P option is intended to allow the user to specify the number of CPUs to use for this command, but it is currently ignored.

Examples:

mged> facetize region1.nmg region1.r

-- Create a facetized BOT version of existing object region1.r.

find <objects>

The "find" command displays all combinations that have any of the objects specified as a member.

Examples:

mged> find shapea

-- List all combinations that refer to shapea.

fracture NMG_shape [prefix]

The "fracture" command creates a new NMG shape for every "face" in the specified NMG_shape. The new shapes will be named by adding an underscore and a number to the prefix. If no prefix is specified, then the NMG_shape name provided is used in place of the prefix.

Examples:

mged> fracture shape1.nmg f

g groupname <objects>

The "g" command creates a special type of combination often referred to as a group. This builds a combination by unioning together all the listed objects. If groupname already exists, then the list of objects will be unioned to the end of it. (Note that an existing groupname is not restricted to being a group; any combination is legal.) Other commands to build combinations are c, r, or comb.

Examples:

mged> g shape1.nmg f

-- Create or extend shape1.nmg by unioning in f.

garbage_collect

The "garbage_collect" command eliminates unused space in a BRL-CAD database file.

Examples:

mged> garbage_collect

-- Clean out unused space in the database.

gui [-config b|c|g] [-d display_string] [-gd graphics_display_string] [-dt graphics_type] [-id name] [-c -h -j -s]

This command is used to create an instance of MGED�s default Tcl/Tk graphical user interface (GUI). The following options are allowed:

heal [command]

The "heal" command takes in the bot as input along with the tolerances. As of now, it takes the tolerance only for zippering.

The healing essentially comprises only of zippering now, but more features will be added later on. The algorithm cannot support non-manifold meshes (those containing singular vertices or edges). The bots need not be oriented, the algorithm takes care of that.

Examples:

mged> heal samplebot.s 47.3

help [command]

The "help" command returns a list of available MGED commands along with a one-line usage message for each. If a command is supplied as an argument, the one-line usage message for that command is returned. The helpdevel, helplib, ?, ?devel, and ?lib commands provide additional information on available commands.

Examples:

mged> help ae

-- Display a one-line usage message for the ae command.

helpdevel [command]

The "helpdevel" command returns a list of available developer commands along with a one-line usage message for each. If a command is supplied as an argument, the one-line usage message for that command is returned. The help, helplib, ?, ?devel,and ?lib commands provide additional information on available commands.

Examples:

mged> helpdevel winset

-- Display a one-line usage message for the winset command.

helplib [command]

The "helplib" command returns a list of available library commands along with a one-line usage message for each. If a command is supplied as an argument, the one-line usage message for that command is returned. The help, helpdevel, ?, ?devel, and ?lib commands provide additional information on available commands.

Examples:

mged> helplib mat_trn

-- Display a one-line usage message for the mat_trn command.

---

hide <objects>

The "hide" command sets the "hidden" flag for the specified objects. When this flag is set, the objects do not appear in t or ls command outputs. The -a option on the ls or t command will force hidden objects to appear in its output.

Examples:

mged> hide sol_a

-- Mark sol_a as hidden.

---

history [-delays]

The "history" command displays the list of commands executed during the current MGED session. The one exception is the hist_add command, which can add a command to the history list without executing it. If the -delays option is used, then the delays between commands will also be displayed.

Examples:

mged> history

-- Display the command history list.

i obj_name comb_name [operation]

The "i" command adds obj_name to the end of the combination named comb_name. The operation may be "+," "-," or "u." If no operation is specified, "u" is assumed. If comb_name does not exist, it is created.

Examples:

mged> i region3 group5

-- Add region3 to the combination group5.

idents file_name <objects>

The "idents" command places a summary of the regions in the list of objects specified in the file specified. If any regions include other regions, then only the first encountered region in that tree will be listed. The resulting file will contain two lists of regions, one in the order encountered in the list of objects, and the other ordered by ident number. The data written for each region includes (in this order) a sequential region count, the ident number, the air code, the material code, the LOS, and the path to the region.

Examples:

mged> idents regions_file group1 group2 region3

ill obj_name

The "ill" command performs the function of selecting an object after entering solid (i.e., primitive) illuminate or object illuminate mode. In solid illuminate mode, this command selects the specific shape for editing. In object illuminate mode, this command selects the leaf object for the object path, then the user may use the mouse to select where along the object path the editing should be applied. In both modes, the ill command will only succeed if the specified obj_name is only referenced once in the displayed objects; otherwise a multiply referenced message will be displayed. If the ill command fails, the user must resort to either using the mouse to make the selection, or using aip and M 1 0 0.

Examples:

mged> ill shapea

-- Select shapea for editing.

in [-f] [-s] new_shape_name shape_type <parameters>

The "in" command allows the user to type in the arguments needed to create a shape with the name new_shape_name of the type shape_type. The command may be invoked with no arguments, and it will prompt the user for all needed information. The -s option will invoke the primitive edit mode on the new shape immediately after creation. The -f option does not draw the new shape, and therefore the -s option may not be used in conjunction with -f. The possible values for shape_type are:

• arb8 -- ARB (eight vertices).
• arb7 -- ARB (seven vertices).
• arb6 -- ARB (six vertices).
• arb5 -- ARB (five vertices).
• arb4 -- ARB (four vertices).
• arbn � Arbitrary polyhedron with arbitrary number of vertices (plane equations).
• bot � Bag of Triangles.
• dsp � Displacement Map.
• pipe � Pipe (run of connected pipe or wire).
• ebm --Extruded Bit Map.
• vol --Voxels.
• hf -- Height Field deprecated, see dsp.
• ars -- Arbitrary Faceted Solid.
• half -- Half Space.
• sph -- Ellipsoid (center and radius).
• ell -- Ellipsoid (center and three semi-axes).
• ellg -- Ellipsoid (foci and chord length).
• ell1 -- Ellipsoid (center, one semi-axis, and a radius of revolution).
• tor -- Torus.
• tgc -- Truncated General Cone (most general TGC).
• tec -- Truncated General Cone (top radii are scaled from base radii).
• rec -- Truncated General Cone (right elliptical cylinder).
• trc -- Truncated General Cone (truncated right circular cone).
• rcc -- Truncated General Cone (right circular cylinder).
• box -- ARB (vertex and three vectors).
• raw -- ARB (right angle wedge).
• rpp -- ARB (axis aligned rectangular parallelepiped).
• rpc -- Right Parabolic Cylinder.
• rhc -- Right Hyperbolic Cylinder.
• epa -- Elliptical Paraboloid.
• ehy -- Elliptical Hyperboloid.
• eto -- Elliptical Torus.
• part -- Particle.

Examples:

mged> in new1 raw 0 0 0 0 0 1 1 0 0 0 1 0

-- Create an ARB named new1 in the form of a right angle wedge.

inside [outside_shape_name new_inside_shape_name <parameters>]

The "inside" command creates a new shape that is inside an existing shape. This command is typically used to create an inside shape that can be subtracted from the original shape to produce a hollow shell. The command is typically used with no arguments, and it prompts the user for all needed information; however, all the parameters may be supplied on the command line. If MGED is in primitive edit mode when the "inside" command is issued, then the shape currently being edited will be used as the "outside_shape." Similarly, if MGED is in matrix edit mode when the "inside" command is executed, then the current key shape will be used as the outside shape.

Examples:

mged> inside out_arb in_arb 1 1 1 1 1 1

item region_name ident_number [air_code [material_code [LOS]]]

The "item" command sets the values of ident_number, aircode, material_code, and LOS for the specified region.

Examples:

mged> item region_1 1137 0 8 100

joint command [options]

articulation/animation commands (experimental)

?

This command returns a list of available joint commands.

accept [-m] [joint_names]

debug [hex code]

help [commands]

This command returns a usage message for each joint command.

holds [names]

list [names]

load file_name

mesh

move joint_name p1 [p2...p6]

reject [joint_names]

save file_name

solve constraint

test file_name

unload

---

journal [-d] [journal_file_name]

The "journal" command starts or stops the journaling of MGED commands to a file. If executed with no arguments, the command stops journaling. If journal_file_name is provided, that file will become the recipient of the journaling. If a -d option is also provided, the journaling will include the delays between commands. Journaling is off by default.

Examples:

mged> journal journal_file

-- Start journaling to journal_file.

---

keep keep_file <objects>

The "keep" command copies the objects specified to the keep_file. If keep_file does not exist, it is created. If keep_file does exist, the objects are appended to it. The keep_file is a BRL-CAD database file. The objects in the list must exist in the current database.

Examples:

mged> keep sample.g sample1 sample2

-- Create sample.g file with objects sample1 and sample2 in it.

---

keypoint [x y z | reset]

The "keypoint" command without any options displays the current keypoint setting. If a point is specified, then that point becomes the keypoint. If reset is specified, then the default keypoint is restored. The keypoint is used as the center of rotation and scaling in primitive edit or matrix edit (formerly known as object edit) modes. This command has no effect when used in nonediting modes.

Examples:

mged> keypoint 10 20 30

-- Set the keypoint to the point (10 20 30) in model units.

---

kill [-f] <objects>

The "kill" command deletes the specified objects from the current database. This command affects only the objects actually listed on the command line. If a combination is killed, its members are not affected. If the -f option is specified, then kill will not complain if some, or all, of the objects specified do not actually exist in the database. Note that the objects are killed immediately. There is no need for a "write file" command in MGED, and there is no "undo" command. Use this command with caution. Other commands that remove objects from the database are killall and killtree.

Examples:

mged> kill group1 region2 shapeb

-- Destroy group1, region2, and shapeb.

---

killall <objects>

The "killall" command deletes the specified objects from the current database and removes all references to them from all combinations in the database. Note that the objects are killed immediately. There is no need for a "write file" command in MGED, and there is no "undo" command. Use this command with caution. Other commands that remove objects from the database are kill and killtree.

Examples:

mged> killall group1 region2 shapeb

-- Destroy group1, region2, and shapeb and remove all references to these objects from the database.

---

killtree <objects>

The "killtree" command deletes the specified objects from the current database and recursively deletes all objects referenced by any of those objects. If one of the objects listed is a combination, then that combination as well as any objects that are members of that combination will be deleted. If a member of that combination is itself a combination, then all of its members will also be destroyed. This continues recursively until the primitive shapes are reached and destroyed. Note that the objects are killed immediately. There is no need for a "write file" command in MGED, and there is no "undo" command. Use this command with extreme caution. Other commands that remove objects from the database are kill and killall.

Examples:

mged> killtree group1 region2 shapeb

-- Destroy group1, region2, and shapeb and remove all references to these objects from the database.

---

knob [-e -i -m -v] [-o v|m|e|k] [zap|zero|(id [val])]

The "knob" command is used internally by MGED in the processing of knob input devices and is not recommended for users. The knob command provides a method for simulating knob input. With no options, it will display the current values for the knobs. With the zap or zero command provided, all the knob values will be reset to zero. If an id and value are provided, the specified knob setting will be simulated. If the -i option is specified, then the value provided will be used as an increment to be applied to the indicated knob. The knobs have different functions depending on the current mode. For example, if in primitive or matrix edit mode and a rotation or translation function is selected, the knob effects are applied to the edited object by default. However, the -v (view coordinates) and -m (model coordinates) options may be used to adjust the view without modifying primitives or matrices. The -e option allows the knob effects to be applied to the edited object when they would normally be applied to the view. The -o option allows the origin of rotation to be specified with v, m, e, and k, indicating view, model, and eye and keypoint, respectively. The units for value are degrees for rotation and local units for translation. The available knob ids are:

• x -- rate-based rotation about horizontal axis.
• y -- rate-based rotation about vertical axis.
• z -- rate-based rotation about axis normal to screen.
• X -- rate-based translation in horizontal direction.
• Y -- rate-based translation in vertical direction.
• Z -- rate-based translation in direction normal to screen.
• S -- rate-based Scale or Zoom.
• ax -- absolute rotation about horizontal axis.
• ay -- absolute rotation about vertical axis.
• az -- absolute rotation about axis normal to screen.
• aX -- absolute translation in horizontal direction.
• aY -- absolute translation in vertical direction.
• aZ -- absolute translation in direction normal to screen.
• aS -- absolute Scale or Zoom.
• xadc -- absolute translation of adc in horizontal direction (screen coordinates -2048 to +2048).
• yadc -- absolute translation of adc in vertical direction (screen coordinates -2048 to +2048).
• ang1 -- absolute rotation of adc angle1 (degrees).
• ang2 -- absolute rotation of adc angle2 (degrees).
• distadc -- distance setting of the adc (screen coordinates -2048 to +2048).

 

Examples:

mged> knob y 1

-- Start the view rotating about the vertical axis.

---

l [-r] <objects>

The "l" command displays a verbose description about the specified list of objects. If a specified object is a path, then any transformation matrices along that path are applied. If the final path component is a combination, the command will list the Boolean formula for the combination and will indicate any accumulated transformations (including any in that combination). If a shader and/or color has been assigned to the combination, the details will be listed. For a region, its ident, air code, material code, and LOS will also be listed. For primitive shapes, detailed shape parameters will be displayed with the accumulated transformation applied. If the -r (recursive) option is used, then each object on the command line will be treated as a path. If the path does not end at a primitive shape, then all possible paths from that point down to individual shapes will be considered. The shape at the end of each possible path will be listed with its parameters adjusted by the accumulated transformation.

Examples:

mged> l region1

-- Display details about region1.

mged> l group1/group2/region1/shape3
-- Display shape parameters for shape3 with matrices applied from the path.

mged> l -r a/b
-- Display all possible paths that start with a/b and end in a primitive shape
-- The shape parameters with the accumulated transformation applied will be displayed.

---

labelvert <objects>

The "labelvert" command labels the vertices of the indicated objects with their coordinate values in the MGED display window. The objects must have already been displayed using e, E, ev, B, or any other command that results in the display of an object.

Examples:

mged> labelvert shapeb

-- Place coordinate values in display near the vertices of shapeb.

---

listeval [path]

Combinations may include transformation matrices to be applied to their members. A path through a series of combinations and ending with a primitive shape represents that primitive shape with the transformations accumulated through the path applied to it. The "listeval" command displays primitive shape parameters after applying the accumulated transformations from the indicated path. If the specified path does not end at a primitive shape, then all possible paths from the indicated path to any primitive shape will be evaluated and displayed.

Examples:

mged> listeval group1/region1/shapeb

-- Display the parameters for shapeb after applying the transformation matrix from group1 for region1 and the transformation matrix from region1 for shapeb.

---

lm [-l] [values]

The "lm" command with no values argument lists the name of every region in the database (in alphabetical order), except for those marked as hidden with the hide command. If the values argument is supplied, only those regions with a "MUVES_Component" attribute having one of the values are listed. The �l option specifies to use a long format showing object name, object type, major type, minor type, and length.

Examples:

mged> lm engine

--List all regions with "MUVES_Component" attribute having a value of "engine".

mged> lm �1 engine pilot

--List all regions with "MUVES_Component" attribute having a value of "engine" or "pilot," and use the long format.

---

loadtk

The "loadtk" command loads the initialization for the Tk window library. This is normally done automatically when the user attaches any display manager for MGED. If no display manager is attached, then the user must execute loadtk prior to using any Tk facilities.

Examples:

mged> loadtk

-- Initialize the Tk window library.

---

lookat x y z

The "lookat" command adjusts the current view in MGED such that the eye is looking in the direction of the given coordinates, but does not move the eye point nor change the view size. This is similar to just rotating the viewers head to look at the specified point, putting that point in the center of the MGED display. The center command performs a similar function, but moves the eye_pt without changing the viewing direction.

Examples:

mged> lookat 10 20 30

-- Rotate the view to place the point (10 20 30) (model coordinates) in the center of the display.

---

ls [-A -o -a -c -r -s -p -l] [objects]

The "ls" command with no object argument lists the name of every object in the database (in alphabetical order) except for those marked as hidden with the hide command. If the object argument is supplied, only those objects are listed. The object argument may include regular expressions. If the -A option is used, then the arguments are expected to be a list of attribute name/value pairs, and objects having attributes that match the provided list are listed. By default, an object must match all the specified attributes in order to be listed; however, the -o flag indicates that an object matching at least one attribute name/value pair should be listed. See the attr command for information on how to set or get attributes. Regular expressions are not supported for attributes. The following options are also allowed:

• a - List all objects in the database.
• c - List all non-hidden combinations in the database.
• r - List all non-hidden regions in the database.
• s - List all non-hidden primitives in the database.
• p - List all non-hidden primitives in the database.
• l - Use long format showing object name, object type, major type, minor type, and length.

The ls command is a synonym for the t command. Note that when any of the above options are used, the output is not formatted.

Examples:

mged> ls shape*

-- List all objects with names beginning with "shape" (output is formatted).

mged> ls -a shape*
-- List all objects with names beginning with "shape."

mged> ls -p wheel*
-- List all primitives with names beginning with "wheel."

mged> ls -r wheel*
-- List all regions with names beginning with "wheel."

mged> ls -c suspension*
-- List all combinations with names beginning with "suspension."

mged> ls -A -o -r Comment {First comment} Comment {Second comment}

-- List all regions that have a "Comment" attribute that is set to either "First comment" or "Second comment."

---

make -t | new_shape type

The "make" command creates a new_shape of the indicated type. The new_shape is sized according to the current view size and is dependent on the type. The possible values for type are:

• arb8 -- ARB (eight vertices).
• arb7 -- ARB (seven vertices).
• arb6 -- ARB (six vertices).
• arb5 -- ARB (five vertices).
• arb4 -- ARB (four vertices).
• bot -- BOT (Bag Of Triangles).
• sph -- Ellipsoid (sphere).
• ell -- Ellipsoid (ellipsoid of revolution).
• ellg -- Ellipsoid (general ellipsoid).
• tor -- Torus.
• tgc -- Truncated General Cone (most general TGC).
• tec -- Truncated General Cone (truncated elliptical cone).
• rec -- Truncated General Cone (right elliptical cylinder).
• trc -- Truncated General Cone (truncated right circular cone).
• rcc -- Truncated General Cone (right circular cylinder).
• half -- Half Space.
• rpc -- Right Parabolic Cylinder.
• rhc -- Right Hyperbolic Cylinder.
• epa -- Elliptical Paraboloid.
• ehy -- Elliptical Hyperboloid.
• eto -- Elliptical Torus.
• part -- Particle.
• nmg -- Non-Manifold Geometry (an NMG consisting of a single vertex is built).
• pipe -- Pipe.
• grip -- support for joints.
• extrude -- experimental.
• sketch -- experimental.

 

Examples:

mged> make shapea sph

-- Create a sphere named shapea.

mged> make -t
-- Return a list of shape types handled by make.

---

mater combination [shader_parameters[RGB [inheritance]]]

The "mater" command assigns shader parameters, RGB color, and inheritance to an existing combination. The information may be included on the command line; otherwise the user will be prompted for it. Some available shaders are:

• bump -- bump maps.
• bwtexture -- black and white texture maps.
• camo -- camouflage.
• checker -- checkerboard design.
• cloud -- 2D Geoffrey Gardner style cloud texture map.
• envmap -- environment mapping.
• fakestar -- a fake star pattern.
• fbmbump -- fbm noise applied to surface normal.
• fbmcolor -- fbm noise applied to color.
• fire -- flames simulated with turbulence noise.
• glass -- Phong shader with values set to simulate glass.
• gravel -- turbulence noise applied to color and surface normal.
• light -- light source.
• marble -- marble texture.
• mirror -- Phong shader with values set to simulate mirror.
• plastic -- Phong shader with values set to simulate plastic.
• rtrans -- random transparency.
• scloud -- 3D cloud shader.
• spm -- spherical texture maps.
• stack -- allows stacking of shaders.
• stxt -- shape texture mapping.
• texture -- full color texture mapping.
• turbump -- turbulence noise applied to surface normals.
• turcolor -- turbulence noise applied to color.
• wood -- wood texture.

Examples:

mged> mater region1 "plastic {tr 0.5 re 0.2}" 210 100 100 0

-- Set region1 to use the plastic shader with 50% transparency, 20% reflectivity, a base color of (210 100 100), and inheritance set to 0.

---

matpick #|combination/member

The "matpick" command selects which matrix in the illuminated path should be edited. A number may be specified with 0 being the topmost selection. A combination/member may be specified to indicate that the matrix in combination that corresponds to member is to be edited. This command is only useful in matrix edit mode at the point where the user is selecting which matrix in the illuminated path should be edited. It is used internally by MGED; the user should generally use the mouse to make this selection.

Examples:

mged> matpick group1/region3

-- Select the matrix for region3 in group1 for editing.

---

mirface #### x|y|z

The "mirface" command modifies an ARB shape by mirroring the indicated face along the selected x, y, or z axis. An ARB shape must be selected for editing. Not all faces of all ARB types may be edited using this command.

Examples:

mged> mirface 1234 x

-- Modify currently edited ARB by moving the face opposite face 1234 such that it is the mirror image of face 1234 across the yz plane.

---

mirror old_object new_object x|y|z

The "mirror" command creates new_object by duplicating old_object and reflecting it along the indicated axis. If old_object is a primitive shape, then a new shape is created, with parameters adjusted to accomplish the mirror operation. If old_object is a combination, then new_object will simply be a copy of old_object with all of its members� matrices set to perform the appropriate reflection.

Examples:

mged> mirror shape1 shape1_mirror x

-- Make a copy of shape1, name it shape1_mirror, and adjust its parameters so that it is a mirror image of shape1 across the yz plane.

---

mrot x y z

Rotate the view using model x y z.

Examples:

mged> mrot 0 0 10

-- Rotate the view about the model z axis by 10˚.

---

mv old_name new_name

The "mv" command changes the name of old_name to new_name. Note that this does not change any references to old_name that may appear in other combinations in the database. The mvall command will change an object�s name everywhere.

Examples:

mged> mv shapea shapeb

-- Change the name of shapea to shapeb.

---

mvall old_name new_name

The "mvall" command changes the name of old_name to new_name. This will also change any references to old_name that may appear in other combinations in the database. The mv command will change an object�s name without changing references to it. The prefix command will also change the names and references of objects.

Examples:

mged> mvall shapea shapeb

-- Change the name of shapea to shapeb everywhere it occurs in the database.

---

nirt [nirt_args]

The "nirt" command runs the nirt program that is distributed with BRL-CAD to intersect a single ray with the displayed objects. By default, nirt is run using the current database and the currently displayed objects, and it uses the current eye point as the ray start point and the current viewing direction as the ray direction. This effectively fires a ray at the center of the MGED display. The resulting collection of intersections between the ray and the objects is listed. Additional arguments may be supplied on the nirt command line. See the man page of nirt for more details.

Examples:

mged> nirt

-- Fire a single ray through the center of the MGED display.

---

nmg_collapse old_nmg_shape new_nmg_shape maximum_error_dist [minimum_angle]

The "nmg_collapse" command simplifies an existing nmg_shape by a process of edge decimation. Each edge in the old_nmg_shape is considered; if it can be deleted without creating an error greater than the specified maximum_error_dist, then that edge is deleted. If a minimum_angle is specified (degrees), then the edge will not be deleted if it would create a triangle with an angle less than minimum_angle. The resulting shape is saved in new_nmg_shape. The old_nmg_shape must have been triangulated previous to using the nmg_collapse command. The resulting shape consists of all triangular faces.

Examples:

mged> nmg_collapse nmg_old nmg_new 1.0 10.0

-- Decimate edges in nmg_old to produce an NMG with an error no greater than 1.0 units. The process will not create any triangles with an angle less than 10˚. The new NMG shape will be named nmg_new.

---

nmg_simplify [arb|tgc|poly] new_shape nmg_shape

The "nmg_simplify" command attempts to convert an existing nmg_shape to a simpler primitive shape type. The user may specify which type to attempt by including arb, tgc, or poly on the command line. If no shape type is specified, all will be attempted in the above order. If tgc is specified, the code will attempt to determine if the nmg_shape is an approximation of a TGC shape.

Examples:

mged> nmg_simplify poly shapea.poly shapea.nmg

-- Convert the NMG shape named shapea.nmg to a polysolid named shapea.poly.

---

oed path_lhs path_rhs

The "oed" command places MGED directly into the matrix edit mode. The path_rhs must be a path to a primitive shape, and path_lhs must be a path to a combination that includes the first component of path_rhs as one of its members. Also, path_rhs/path_lhs must be a path that is currently displayed in mged. The edited matrix will be the matrix in the final component of path_lhs that corresponds to the first component of path_rhs. The last component in path_rhs is used as the reference shape during object editing.

Examples:

mged> oed group1/group2 region1/shapea

-- Place MGED into matrix edit mode, editing the matrix in group2 that corresponds to region1, using shapea as the reference shape.

---

opendb [database.g]

The "opendb" command closes the current database file and opens database.g. If database.g is not found, the current database is left open. If database.g is not specified on the command line, the name of the current database file is returned.

Examples:

mged> opendb model.g

-- Close the current database file and open model.g.

mged> opendb
-- Return the name of the current database file.

---

orientation x y z w

The "orientation" command sets the view direction for MGED from the quaternion specified on the command line.

Examples:

mged> orientation 1 0 0 0

-- Set viewing direction to bottom.

---

orot [-i] xdeg ydeg zdeg

The "orot" command performs a rotation of an object during matrix edit. The rotation is performed, in order: xdeg about the x axis, then ydeg about the y axis, and finally zdeg about the z axis. If the -i flag is given, then the angles are interpreted as increments to the last object rotation. The rotobj command is a synonym for orot.

Examples:

mged> orot 0 0 35

-- Rotate currently edited object by 35˚ about the Z-axis from the original orientation.

---

oscale scale_factor

The "oscale" command of matrix edit mode modifies the matrix to perform a uniform scale operation. A scale_factor of 2 doubles the size of the associated object, and a scale_factor of 0.5 reduces it by half.

Examples:

mged> oscale 3

-- Increase the size of the currently edited object by a factor of 3.

---

overlay plot_file [name]

The "overlay" command plots the specified UNIX plot_file in the MGED display. Phony object names are created for each part of the plot file that is in a unique color. The names are created by adding a color to the specified name, or to "_PLOT_OVER" if no name is provided. The color suffix is built by converting the RGB color to a six digit hex number. Each color corresponds to 2 hex digits, so that white becomes "ffffff," red becomes "ff0000," green is "00ff00," etc.

Examples:

mged> overlay plot.upl tmp

-- Plot the Unix plot file plot.upl in the MGED display, using tmp as the base for the phony object names.

---

p value1 [value2 value3]

The "p" command provides precise control over primitive editing operations that would normally be done using the mouse or knobs. For example, a shape rotate may be performed by selecting rotate from the primitive edit menu, then providing the rotation angles with the p command. A command of "p 0 30 0" would rotate the edited shape through 30˚ about the y axis. Similarly, many of the individual parameters of the edited shape may be set exactly using the p command. If the scale H menu item is selected while editing a TGC, then the value1 supplied with a p command specifies the actual length of the height vector for that TGC. This method is the recommended technique to set precise values for shape parameters. The translate and rotobj commands provide a similar capability for object editing.

Examples:

mged> p 30

-- Set the currently selected shape parameter of the currently edited shape to 30 units.

---

pathlist <combinations>

The "pathlist" command lists all existing paths that start from the specified combinations and end at a primitive shape.

Examples:

mged> pathlist group1 region2

-- List all existing paths that start from the combinations group1 and region2 and end at primitive shapes.

---

paths path_start

The "paths" command lists all existing paths that start from the specified path_start and end at a primitive shape. The path_start may be specified by "/" separated components, or they may be separated by spaces (but not both).

Examples:

mged> paths group1 region2

-- List all existing paths that start from group1/region2 and end at a primitive shape.

---

permute tuple

The "permute" command permutes the vertex labels for the face of an ARB shape that is currently being edited. The tuple indicates which face is affected and also indicates the desired result. The tuple is formed by concatting the list of vertex numbers for the face in the order desired such that the first vertex listed will become vertex number one (and therefore the default keypoint). Only a sufficient number of vertices to disambiguate need be included in the tuple. Note that this has no effect on the geometry of the ARB, but may affect any texture mapping involving this shape.

Examples:

mged> permute 321

-- Rearrange the vertices of the currently edited ARB such that vertex #3 becomes vertex #1, vertex #2 remains #2, and vertex #1 becomes #3.

---

plot [-float] [-zclip] [-2d] [-grid] out_file | "|" filter

The "plot" command creates a UNIX plot of the current MGED display. If an output_file is specified, the plot is stored in that file. If a filter is specified, the output is sent to that filter. The -float option requests a plot file with real numbers rather than integers. The -zclip option requests that the plot be clipped to the viewing cube in the Z-direction. The -2d option requests a two-dimensional plot (the default is 3D). The -grid option is intended to include a grid in the plot, but is currently not implemented. This command does not use the dm-plot display manager. The pl command performs the same function, but does use the dm-plot display manager.

Examples:

mged> plot -float | pldebug

-- Create a UNIX plot of the current MGED display and pipe the results to the pldebug command.

prcolor

The "prcolor" command lists the entries in the ident-based color table. The ident number for a displayed region is used to find the appropriate color from the lookup table. The low and high values are the limits of region ident numbers to have the indicated r g b color (0-255) applied. The color table entries may be modified using the color command, and the entire color table may be edited using the edcolor command. If a color lookup table exists, its entries will override any color assigned using the mater command.

prefix new_prefix <objects>

The "prefix" command changes the name of all the objects listed by adding the specified new_ prefix. All references to the objects will also be changed. The mvall command performs a similar function.

Examples:

mged> prefix test_ group1 regiona shapeb

prj_add [-t] [-b] [-n] shaderfile [image_file] [image_width] [image_height]

The "prj_add" command appends information to the specified shaderfile. The information appended is in the form required by the "projection" shader (prj) and includes the image_file (typically a "pix" file), the image_width and image_height, and current view parameters from the MGED display. The resulting shaderfile may then be used as the parameter to the prj shader. Before executing this command, the region wireframe display in MGED should be aligned with the image_file (underlaid in MGED�s framebuffer) and the image_file should have the same height and width as the mged display. The -t option indicates that the image should be projected through the object. The -n option requests that antialiasing not be done.

---

press button_label

The "press" command simulates the pressing of a button. All of these button actions can be run directly as a command. The button_label indicates which button to simulate. The available buttons are:

• help -- Provide a list of the available button_labels.
• 35,25 -- Switch to a view from an azimuth of 35˚ and an elevation of 25˚.
• 45,45 -- Switch to a view from an azimuth of 45˚ and an elevation of 45˚.
• accept -- Simulate the accept button (accepts edits and writes the edited object to the database).
• reject -- Simulate the reject button (discards edits).
• reset -- Resets view to top and resizes such that all displayed objects are within the view.
• save -- Remember the current view aspect and size.
• restore -- Restore the most recently saved view.
• adc -- Toggle display of the adc.
• front -- Switch to view from the front (synonym for ae 0 0).
• left -- Switch to view from the left (synonym for ae 90 0).
• rear -- Switch to view from the rear (synonym for ae 180 0).
• right -- Switch to view from the right (synonym for ae 270 0).
• bottom -- Switch to view from the bottom (synonym for ae -90 -90).
• top -- Switch to view from the top (synonym for ae -90 90).
• oill -- Enter object illuminate mode.
• orot -- Enter object rotate mode (must already be in matrix edit mode).
• oscale -- Enter object scale mode (must already be in matrix edit mode).
• oxscale -- Enter object scale (x-direction only) mode (must already be in matrix edit mode).
• oyscale -- Enter object scale (y-direction only) mode (must already be in matrix edit mode).
• ozscale -- Enter object scale (z-direction only) mode (must already be in matrix edit mode).
• oxy -- Enter object translate mode (must already be in matrix edit mode).
• ox -- Enter object translate (horizontal only) mode (must already be in matrix edit mode).
• oy -- Enter object translate (vertical only) mode (must already be in matrix edit mode).
• sill -- Enter solid (i.e., primitive) illuminate mode.
• sedit -- (deprecated) Enter primitive edit mode.
• srot -- Enter solid (i.e., primitive) rotate mode (must be in primitive edit mode).
• sscale -- Enter solid (i.e., primitive) scale mode (must be in primitive edit mode).
• sxy -- Enter solid (i.e., primitive) translate mode (must be in primitive edit mode).
• zoomin -- Zoom in, synonym for zoom 2.
• zoomout -- Zoom out, synonym for zoom 0.5.
• rate -- Toggle between rate and absolute mode for knobs and sliders.
• edit � (deprecated) Toggle between edit and view modes for knobs and sliders (useful during editing to allow the knobs and sliders to be used for either editing operations (in edit mode) or to adjust the view without affecting the edited object (in view mode).

Examples:

mged> press top

-- Switch to view from the top direction.

preview [-v] [-d delay] [-D start_frame_number] [-K end_frame_number] rt_script_file

The "preview" command allows the user to preview animation scripts in MGED. The -d option provides a delay in seconds to be applied between each frame (the default is no delay). The -D option allows the user to specify a starting frame number, and the -K option allows the specification of an ending frame number. The -v flag indicates that the objects displayed in the MGED graphics window should be displayed in "evaluated" mode, as would be the result of the ev command. Note that this may significantly slow the preview.

Examples:

mged> preview -D 101 -K 237 script.rt

-- Preview the animation script stored in the file named script.rt from frame number 101 through frame number 237.

prj_add shaderfile [image_file] [image_width] [image_height]

The "prj_add" command appends information to the specified shaderfile. The information appended is in the form required by the "projection" shader (prj) and includes the image_file (typically a "pix" file), the image_width and image_height, and current view parameters from the MGED display. The resulting shaderfile may then be used as the parameter to the prj shader. Before executing this command, the region wireframe display in MGED should be aligned with the image_file (underlaid in MGED�s framebuffer), and the image_file should have the same height and width as the MGED display.

ps [-f font] [-t title] [-c creator] [-s size_in_inches] [-l line_width] output_file

The "ps" command temporarily attaches the Postscript display manager and outputs the current MGED display to the specified output_file in PostScript format. The -f option allows the font to be user-specified. The -t option allows the user to provide a title (the default is "No Title"). The -c option allows the user to specify the creator of the file (the default is "LIBDM dm-ps"). The �s specifies the size of the drawing in inches. The �l specifies the width of the lines drawn.

Examples:

mged> ps -t "Test Title" test.ps

pull <objects>

The "pull" command pulls the effects of all transformation matrices that appear in any primitive shapes or combinations in the trees up to the specified objects heading the tree. This will restore the original the parameters of the primitive shapes if any of the transformation matrices are not identity matrices. All the transformation matrices visited up the tree will be set to the current transformation matrix. This command will fail, and no changes will be made, if the head is referenced by a primitive shape.

Examples:

mged> pull group1 regiona

push <objects>

The "push" command forces the effects of all transformation matrices that appear in any combinations in the trees from the specified objects down to the primitive shapes. This will change the parameters of the primitive shapes if any of the transformation matrices are not identity matrices. All the transformation matrices visited will be set to identity matrices. This command will fail, and no changes will be made, if any primitive shape referenced by the list of objects is positioned differently in two or more combinations. The xpush command will perform a similar function, even if some shapes are multiply referenced.

Examples:

mged> push group1 regiona

putmat comb_name/member_name {I | m0 m1 m2 m3 ... m16}

The "putmat" command replaces the existing transformation matrix in the combination specified that corresponds to the member specified. The transformation matrix may be specified with an "I" to indicate the identity matrix, or it may be specified as 16 elements listed row-by-row. The copymat command allows the user to copy an existing transformation matrix.

Examples:

mged> putmat group1/regiona I

-- Set the transformation matrix for regiona in group1 to the identity matrix.

q

The "q" command ends the MGED process. Note that there is no write database command in MGED. All changes are made to the database as the user performs them. Therefore, a q command will not restore the database to its pre-edited state. This is a synonym for the quit command.

Examples:

mged> q

-- Quit the current MGED session.

qorot x y z dx dy dz angle

The "qorot" command rotates an object through the specified angle (in degrees). This command requires that MGED already be in matrix edit mode. The edited object is rotated about the axis defined by the start point (x y z) and the direction vector (dx dy dz).

Examples:

mged> qorot 1 2 3 0 0 1 25

qray [subcommand]

Get/set query ray characteristics. Without a subcommand, the usage message is printed. The qray command accepts the following subcommands:

vars

Print a list of all query ray variables.

basename [str]

If str is specified, then set basename to str. Otherwise, return the basename. Note that the basename is the name used to create the fake shape names corresponding to the query ray. There will be one fake shape for every color used along the ray.

effects [t|g|b]

Set or get the type of effects that will occur when firing a query ray. The effects of firing a ray can be either t for textual output, g for graphical output or b for both textual and graphical.

echo [0|1]

Set or get the value of echo. If set to 1, the actual nirt command used will be echoed to the screen.

oddcolor [r g b]

Set or get the color of odd partitions.

evencolor [r g b]

Set or get the color of even partitions.

voidcolor [r g b]

Set or get the color of areas where the ray passes through nothing.

overlapcolor [r g b]

Set or get the color of areas that overlap.

fmt [r|h|p|f|m|o [str]]

Set or get the format string(s). See the man page of nirt for more details.

script [str]

Set or get the nirt script string.

help

Print the usage message.

Examples:

mged> qray

-- Print usage message.

query_ray [nirt_args]

The "query_ray" command runs the nirt program that is distributed with BRL-CAD to intersect a single ray with the displayed objects. By default, nirt is run using the current database and the currently displayed objects and uses the current eye point as the ray start point and the current viewing direction as the ray direction. This effectively fires a ray at the center of the MGED display. The resulting list of intersections between the ray and the objects is given. Additional arguments may be supplied on the nirt command line. See the man page of nirt for more details.

Examples:

mged> query_ray

-- Fire a single ray through the center of the MGED display.

quit

The "quit" command ends the MGED process. Note that there is no write database command in MGED. All changes are made to the database as the user performs them. Therefore, a quit command will not restore the database to its pre-edited state. This is a synonym for the q command.

Examples:

mged> quit

-- Quit the current MGED session.

qvrot dx dy dz angle

The "qvrot" command adjusts the current MGED viewing direction such that the eye is positioned along the direction vector (dx dy dz) from the view center and is looking towards the view center. The angle (in degrees) allows for a twist about the viewing direction. The ae command provides a similar capability.

Examples:

mged> qvrot 0 0 1 90

-- Set the current view to the same as achieved by the press top command.

r region_name <operation object>

The "r" command creates a region with the specified region_name. The region is constructed using the list of Boolean operations and object pairs. The operators are represented by the single characters "+," "-," and "u" for intersection, subtraction, and union, respectively. The object associated with each operator may be a combination or a primitive shape. No parentheses or any grouping indication is allowed in the r command. The operator hierarchy for the r command has been established through the ancestry of BRL-CAD and does not conform to accepted standards (see the c command for a more standard implementation). Intersection and subtraction operations are performed first, proceeding left to right; then union operations are performed. BRL-CAD regions are special cases of BRL-CAD combinations and include special attributes. Default values for these attributes may be set using the regdef command. As new regions are built, the default ident number gets incremented. If region_name already exists, then the operation/object pairs get appended to its end.

Examples:

mged> r new_region u shape1 - shape2 u shape3 + group4

rcc-blend rccname newname thickness [b|t]

The "rcc-blend" command generates a blend at an end (base [b] or top [t]) of the specified RCC shape. The thickness is the radius of the TOR curvature. The blend is saved as a region made up of an RCC and a TOR. The default end is the base.

Examples:

mged> rcc-blend rcc.s blend.s 10

-- Create a region named blend.s that extends 10 units from the base of rcc.s.

mged> rcc-blend rcc.s blend.s 10 t

-- Create a region named blend.s that extends 10 units from the top of rcc.s.

---

rcc-cap rccname newname [height] [b|t]

The "rcc-cap" command is used to round the end of a cylinder with an ellipsoid. It creates an ELL shape with the given height at one end (base [b] or top [t]) of the specified RCC. If the height option is not specified, a spherical cap will be generated. The default end is the base.

Examples:

mged> rcc-cap rcc.s cap.s 20

-- Create an ELL shape named cap.s with a radius of 20 units at the base of rcc.s.

 

mged> rcc-cap rcc.s cap.s 20 t

-- Create an ELL shape named cap.s with a radius of 20 units at the top of rcc.s.

---

rcc-tgc rccname newname x y z [b|t]

The "rcc-tgc" command creates a TGC shape with the specified apex (x y z) at one end (base [b] or top [t]) of the specified RCC. The default end is the base.

Examples:

mged> rcc-tgc rcc.s tgc.s 0 2 4

-- Create a TGC shape named tgc.s with an apex at (0 2 4) from the base of rcc.s.

 

---

rcc-tor rccname newname

The "rcc-tor" command is used to round the edges of the specified RCC by creating a torus based on the parameters of that RCC. The radius values of the RCC must be greater than half its height.

 

Examples:

mged> rcc-tor rcc.s tor.s

-- Create a TOR shape named tor.s using the parameters of rcc.s.

 

---

rcodes file_name

The "rcodes" command reads the specified file and assigns the region attributes to the regions listed. The file is expected to be in the format produced by the wcodes command.

Examples:

mged> rcodes region_codes

red combination

The "red" command creates a file describing the specified combination and starts an editor for the user to modify the combination. The environment EDITOR variable will be used to select the editor. If EDITOR is not set, then /bin/ed will be used. All the attributes of BRL-CAD regions and combinations may be edited in this way. The region specific attributes will be ignored if the combination is not a region and is not set to be a region during editing. It is not necessary to be in an editing mode to run this command. The rm, r, comb, c, and g commands provide some basic combination editing capabilities.

Examples:

mged> red group2

refresh

The "refresh" command updates the MGED display.

Examples:

mged> refresh

-- Update the MGED display.

regdebug [debug_level]

The "regdebug" command with no options toggles the display manager debug flag. If a debug_level is supplied, then the display manager debug flag is set to that value.

Examples:

mged> regdebug

-- Toggle the display manager debug flag.

regdef item [air [los [material_code]]]

The "regdef" command sets the default region attributes used by the r and c commands when building a BRL-CAD region. The default ident number is incremented each time a new region is created with the r or c commands.

Examples:

mged> regdef 1003 0 100 8

regions output_file <objects>

The "regions" command creates a summary of all the regions in the specified list of objects. The summary is written in the specified output_file. The summary includes, for each region, a sequential region number, its ident, air code, material code, los, the path from one of the objects to the region, and the Boolean formula for the region.

Examples:

mged> regions regions_file group1 group2

release [name]

The "release" command is used to close a display manager. If invoked with no arguments, the current display manager is closed. Otherwise, name (i.e., the Tcl/Tk path name of the display manager window) is closed.

Examples:

mged> release

-- Close the current display manager.

rfarb

The "rfarb" command creates a new ARB8 shape based on rotation and fallback angles. The command prompts the user for all the required information. In addition to the name for the new shape and the rotation and fallback angles, the user is prompted for the coordinates of one corner of the ARB8 and for two of the three coordinates of the other three vertices of one face of the ARB8. The other coordinate of each of these vertices is calculated in order to ensure that the face is planar. The user is then prompted for a thickness, and the first face is extruded normally by the specified thickness to complete the ARB8.

Examples:

mged> rfarb

-- Create a new ARB8 shape according to arguments supplied in answer to prompts.

rm combination <members>

The "rm" command deletes all occurrences of the listed members from the specified combination. The red, r, comb, c, and g commands provide other combination editing capabilities.

Examples:

mged> rm group1 regiona

-- Delete regiona from group1.

rmater file

The "rmater" command reads the specified file and sets the combinationshader, color, and inheritance values according to those listed in the file. The format of the file is expected to be as produced by the wmater command.

Examples:

mged> rmater mater_file

rot x y z

The "rot" command rotates the view or an object by xyz degrees. Exactly what is rotated and how it is rotated are dependent on MGED�s state as well as the state of the display manager. See arot for a similar capability.

Examples:

mged> rot 0 0 45

-- Rotate 45 degrees about the Z axis.

rotobj [-i] x-angle y-angle z-angle

The "rotobj" command rotates the currently edited object by z angle degrees about the z direction, y angle about the y direction, and x angle degrees about the x direction in that order. If an -i option is included, then the rotations are treated as increments to the previous rotations. MGED must be in the matrix edit mode for this command to be useful. The p command provides a similar capability for primitive editing.

Examples:

mged> rotobj 0 0 25

rpp-arch rppname newname face

The "rpp-arch" command is used to round a specified face of an RPP by creating an RCC based on the parameters of the RPP.

Examples:

mged> rpp-arch rpp.s arch.s 1234

-- Create an RCC shape named arch.s at the 1234 face of the RPP.

---

rpp-cap rppname newname face height [0|1]

The "rpp-cap" command creates an ARB6 with the specified height at a particular face of the given RPP. The optional "0" and "1" refer to the orientation of the ARB6. If "0" is chosen, the peaks of the ARB6 are positioned at the midpoint between the first and second points and at the midpoint between the third and fourth points of the specified face. If "1" is chosen, the peaks of the ARB6 are positioned at the midpoint between the first and fourth points and at the midpoint between the second and third points of the specified face. The default is 0.

Examples:

mged> rpp-cap rpp.s cap.s 1234 20

-- Create an ARB6 shape named cap.s that extends 20 units from the 1234 face of the RPP. The peaks of the ARB6 will be at the midpoint between point 1 and 2 and at the midpoint between 3 and 4.

 

mged> rcc-cap rcc.s cap.s 1234 20 1

-- Create an ARB6 shape named cap.s that extends 20 units from the 1234 face of the RPP. The peaks of the ARB6 will be at the midpoint between point 1 and 4 and at the midpoint between 2 and 3.

---

rrt program [options]

The "rrt" command executes the specified program with the provided options and includes the current database name and the list of currently displayed objects on the command line. This command effectively executes:

        program options database_name objects.

        rrt /usr/brlcad/bin/rt -M -s50

Examples:

mged> rrt echo

-- Will list the current database name and the list of currently displayed objects.

rt [options] [-- objects]

The "rt" command executes the BRL-CAD rt program with the default options of
"-s50 �M." If perspective is turned on, then the -p option will be included with the value of the perspective angle. The current database name is added to the end of the rt command line along with either the specified objects or, if none is specified, the list of currently displayed objects. The rt program is written such that options may be repeated, and the last occurrence of an option will override any earlier occurrences. This allows the user to specify other size (-s) options. The rrt command performs a similar function, but may be used to execute other programs as well. The -M option tells rt to read the viewing parameters from standard input. See the man page on rt for details. A related command is saveview, which can be used to create a shell script (batch job) to raytrace this view in the background.

Examples:

mged> rt -s1024 -F/dev/Xl

rtcheck [options]

The "rtcheck" command executes the BRL-CAD rtcheck program with the default options of "-s50 �M." The -M option tells rtcheck to read the viewing parameters from standard input so that rays are only fired from the current view. The current database name and the list of currently displayed objects are added to the end of the rtcheck command line. The rtcheck program is written such that options may be repeated, and the last occurrence of an option will override any earlier occurrences. This allows the user to specify other size (-s) options. The rrt command performs a similar function, but may be used to execute other programs as well. The rtcheck program uses raytracing to check for overlapping regions in the list of objects passed on the command line. When invoked from within MGED, any discovered overlaps along a ray are represented as yellow lines that extend only in the areas of overlap. Details and a count of overlaps are also reported. Note that overlaps of less than 0.1 mm are currently ignored by rtcheck. The default option of -s50 indicates that the checking rays should be fired from a uniform square grid with 50 rays on a side. This is very coarse and may miss significant overlaps. It is recommended that the user select appropriate options for the rtcheck program and execute it for a variety viewing aspects to perform a thorough check. The granularity of the grid may be controlled with the -s, -w, -n, -g, and -G options. See the man page on rtcheck for details.

Examples:

mged> rtcheck -g10 -G10

saveview file [args]

The "saveview" command saves the current viewing parameters in the specified file in the form of a shell script that will run the BRL-CAD rt program as if it had been executed from within MGED using the rt -s512 command. Any args included on the saveview command line will be copied to the file as options to the rt program. If the file already exists, the script will be appended to it. This is useful in setting up images to be raytraced later. The default script produced by "saveview test.rt" looks like:

#!/bin/sh
rt -M \
 -o test.rt.pix\
 $*\
 model.g\
 'object1' 'object2' \
 2>> test.rt.log\
 <<EOF
viewsize 2.780320739746094e+02;
orientation 2.480973490458727e-01 4.765905732660483e-01 7.480973490458729e-01 3.894348305183902e-01;
eye_pt 1.234152656421214e+02 7.220202900588745e+01 3.845765464924686e+01;
start 0; clean;
end;
EOF