• Home
BRL-CAD Reference Manual

  • Articles
    • About BRL-CAD
      • Introduction
    • Animation Tutorial
      • Introduction
        • Preliminaries
        • Simple Camera Motion
        • Object Motion
        • Computing Video Frames
        • Recording Videotape
        • Conclusion
      • Appendix A
        • Name
        • Synopsis
        • Description
        • Example
        • Post Processing
        • Preparing Input Table
        • See Also
        • Diagnostics
        • Bugs
        • Author
        • Source
        • Bug Reports
      • Appendix B
        • Name
        • Synopsis
        • Description
        • Example
        • Post Processing
        • Example 2
        • See Also
        • Diagnostics
        • Bugs
        • Author
        • Source
        • Bug Reports
      • Chains
        • Chains Vsize
        • Chains Eypet
        • Chain Orient
        • Chain all
    • Build Pattern
      • Build Pattern Information
      • Pattern Name
      • Common Fields For All Pattern Fields
      • Strings Substitution
      • Rectangular Patterns
      • Spherical Patterns
      • Cylindrical Patterns
    • Build Region
    • Camouflage Shader
      • Introduction
      • Limitations
    • GED
      • Preface
      • Introduction
      • Comgeom Background
      • Computer Graphics
      • Approach To The Problem
      • GED Overview
      • GED Internal Data Structure
      • Keyboard Commands
      • Peripheral Devices
      • ADC
      • Viewing Functions
      • Selecting Objects For Editing
      • Object Editing
      • Solid Editing
      • Conclusion
    • MGED
      • Preface
      • Modeling With CSG
        • Starting MGED
        • The Screen Coordinate System
        • Creating Geometry
        • Editing Solids
        • Adding A Base
        • Adding A Fillet
      • MGED’s New Graphical User Interface
        • MGED’s New Graphical User Interface
      • Command Line Editing
        • Emacs Bindings
        • Vi Bindings
        • Insert Mode
        • Command Mode
      • MGED User Commands
        • MGED Developer Commands
      • MGED Tcl Variables
      • MGED Environment Variable
      • MGED Callback
      • Glossary
      • BRLCAD Solids
    • MGEDRC
    • About Nirt
      • Nirt: Basic Syntax and Operations
        • Command Line Help
        • Loading A Model
        • Shooting a Ray
        • Moving The Origination Point
        • Backing Out of a Model
        • Changing the Direction of the Ray
        • Reporting of Overlaps
      • Graphical Visualization: NIRT in MGED
        • Basic Usage
        • Backing Out with NIRT in MGED
        • Ray Segment Coloring with NIRT and MGED
        • Mouse-Based NIRT Usage
        • Configuring NIRT
      • Reporting Options
        • How To Change The Report Format
        • Handling Attribute Reporting
        • Changing Units
      • Other Options
        • Silent and Verbose Modes
        • Using Air Regions
        • Reading an Orientation Matrix and Command
      • Scripting NIRT
        • Command Line Scripts
        • Scripts Files
        • Defining a Custom Reporting Format
        • Customizing Report Output in MGED
        • Reporting Attributes in MGED
        • Available Information for Inclusion in Reports
      • Summary
    • oed
      • oed - Basic Syntax and Operations
      • Right Hand Path Selection
      • Flexible_Manipulation
      • Sub-Combination Editing
      • Summary
    • Pipe
      • General Use
      • Making a Coil
    • Projection Shader
      • General
      • Create/Obtain an Image to Project
      • Resize the Graphics Display
      • Ensure the Framebuffer is Active
      • Display the Image
      • Overlay the Image
      • Save the Projection Shader Settings File
      • Render the Image
      • Project the Image on the Front
    • Tire
      • Specifying Tire
      • Options for Tire
      • Setting Tire Thickness
      • Changing the Rim Width
      • Changing the Radial
      • Other Options
      • Structure of a Tire Model
      • Summary
    • Template
  • Books
    • BRL-CAD Tutorial Series-VolumeI
      • What is Brlcad ?
      • Why CSG Modeling?
      • Package Content
      • Libraries
      • Tools Utilities
      • Benchmark Testing
      • Acknowledgments
    • BRL-CAD Tutorial Series-VolumeII
      • Preface
      • Acknowledgments
      • Creating Primitive Shapes
        • Launching the MGED Program
        • Entering Commands
        • Using Gui
        • Open New Database
        • Create New Database
        • Assign Title
        • Set Units
        • Select Primitive
        • Create Sphere Cmd Line
        • Clear Window
        • Draw Object
        • Erase From Window
        • Create Sphere Gui
        • View Params
        • List db Contents
        • Kill Object
        • Editing Commands
        • Quitting
        • Creating Primitive Shapes Review
      • Learning the Viewing Options
        • Creating Radio
        • Locating Viewing info Cmd Window
        • Entering Commands
        • Entering Commands
        • Coord sys Summary
        • View Radio Angles
        • Shift Grips
        • Learning viewing options Review
      • Using the Insert Command to Size and Place Shapes
        • New db MyShapes
        • Sphere Make
        • Using in
        • Args on one Line
        • Command Combined in
        • Mged Naming Conventions
        • View Shapes
        • Using insert command quit
        • using insert command review
      • Assigning Material Properties and Raytracing
        • Assigning material properties and raytracing opendb
        • Create Region
        • Assign Material Prop
        • Clear Window New Region
        • Raytrace Model
        • Layers Graphics Window
        • Clear Graphics Window
        • Review
      • Learning About Boolean Expressions
        • Boolean Tools
        • Making regions bool ops
        • Operator Precedence
        • Review
      • Creating a Goblet
        • Goblet New Database
        • Goblet view Data Tree
        • Raytracing Goblet
        • Creating Goblet Review
        • Making Goblet Regions
        • Making Goblet Region Comb
        • Making Goblet Region Comb
      • Assigning Material Properties to Your Goblet
        • Goblet review opening db
        • Goblet assign colors
        • Goblet transparency mirror
        • Goblet newforms Raytrace
        • Goblet material properties review
      • Assigning More Material Properties to Your Goblet
        • Goblet specular diffuse
        • Goblet refractive index
        • Goblet shininess
        • Goblet extinction
        • Goblet emission
        • Goblet shader attributes
      • Goblet material properties2 review
        • Creating a Globe in a Display Box
        • Globe in display newdb
        • Globe create display box
        • Create globe in box
        • Globe assign mater prop
        • Globe move rotate
        • Globe use color tool
        • Globe in display box review
      • Refining the Mug
        • Mug new db
        • Mug outside cyl
        • Mug handle
        • Mug comb1
        • Mug comb2
        • Mug region
        • Mug review
      • Creating the Mug Through the GUI
        • Mug mater prop mater cmd
        • Mug raytrace1
        • Mug refining
        • Mug torus cup combine
        • Refining mug review
      • Placing Shapes in 3-D Space
        • candle create tabletop
        • candle create base
        • candle create candle
        • candle create flame
        • candle create combination
        • candle check data tree
        • candle assign mater prop
        • candle raytrace
        • placing shapes in 3d review
      • Gaining More Practice Placing Shapes in Space
        • candle base 1st sphere
        • multipane feature
        • copies of shapes
        • practice make regions spheres
        • candle base spheres combine
        • placing shapes in 3d 2 review
        • candle assign mater prop
        • candle raytrace
        • placing shapes in 3d review
      • Creating a Toy Truck
        • truck cab in cmd
        • truck hood in cmd
        • truck cab wheel well
        • ok accept apply reset cancel dismiss
        • truck wheel well prim edit cpy
        • truck cab shape comb
        • truck body in cmd
        • prim ed wheel wells
        • truck body wheel wells comb
        • truck cab body region
        • truck wheels
        • truck wheels region
        • truck regions mater props
        • on screen help
        • stacker shading
        • using stacker shading
        • truck combine regions
        • truck raytracing
        • creating toy truck review
      • Learning Modeling Techniques and Structures
        • Radio shapes to regions
        • body of radio
        • radio other regions
        • radio assembly comb
        • radio assign mater props
        • radio internal components
        • radio specialty models
        • radio structure redefinition
        • modeling techniques and structures review
    • BRL-CAD_Tutorial_Series-VolumeIII
      • Introduction
      • The Model Process
        • The Importance of the Model Mission
        • M-O-D-E-L: A Five-Step Approach to Creating Effective Models
      • Projshader resize
      • Projshader getimage
      • Projshader actframe
      • Projshader dispimage
      • Projshader overlay image
      • Projshader savesettings file
      • Projshader projectfront
      • Build pattern generalinfo
      • Build pattern general Info
      • Build pattern names
      • Build pattern fields
      • Build pattern stringsub
      • Build pattern recpatterns
      • Build pattern cyl ind
      • Build pattern spherical
      • Model process
      • Measuring data
      • organizing
      • develop geometry
      • Build pattern recpatterns
    • BRL-CAD_Tutorial_Series-VolumeIV
      • Introduction
        • Background, Purpose, and Scope
        • The Need for Conversion
      • Pert char
        • CSG_vs._BREP
        • Prerelease 6.0 Database vs. Current Format
        • Converters Currently Available in BRL-CAD
      • Convert from to ascii
        • Converting From ASCII
        • Converting_to_ASCII
      • Convert to brlcad
        • General Information About Converting to BRL-CAD
        • Converting From AutoCAD DXF Format
        • Converting From Elysium Neutral Facetted Format
        • Converting From EUCLID Format
        • Converting From FASTGEN Format
        • Converting From IGES Format
        • Converting From Jack
        • Converting From NASTRAN Format
        • Converting From Pro/E Format
        • Converting From STL Format
        • Converting From TANKILL Format
        • Converting From Unigraphics Format
        • Converting From Viewpoint Datalabs Format
      • Convert from brlcad
        • General Information About Converting From BRL-CAD
        • Converting to ACAD Format
        • Converting to AutoCAD DXF Format
        • Converting to EUCLID Format
        • Converting to IGES Format
        • Converting to Jack
        • Converting to STL Format
        • Converting to TANKILL Format
        • Converting to VRML Format
        • Converting to Wavefront Format
        • Converting to X3D Format
      • Build new converter
        • General Information About Building a New Converter
        • Converting From BRL-CAD
        • Converting to BRL-CAD
      • Postconversion issues
  • Lessons
    • Mged01 creating primitive shapes
      • Launching Mged
      • Entering commands
      • Using gui
      • Open new database
      • Create new database
      • Assign title
      • Set units
      • Select primitive
      • Create sphere cmd line
      • Clear window
      • Clear window
      • Draw object
      • Erase from window
      • Create sphere gui
      • view params
      • List db contents
      • Kill object
      • Editing commands
      • Quitting
      • Creating primitive shapes review
    • Mged02 Learning Viewing Options in MGED
      • Creating radio
      • Locating viewing info cmd window
      • Viewing system elements
      • Coord sys summary
      • View radio angles
      • Shift grips
      • Learning viewing options review
    • Command to Size and Place Shapes
      • New db MyShapes
      • Sphere Make
      • Using in
      • Args on one Line
      • Command Combined in
      • Mged Naming Conventions
      • View Shapes
      • Using insert command quit
      • using insert command review
    • Assigning Material Properties and Raytracing
      • Assigning material properties and raytracing opendb
      • Create Region
      • Assign Material Prop
      • Clear Window New Region
      • Raytrace Model
      • Layers Graphics Window
      • Clear Graphics Window
      • Review
    • Learning About Boolean Expressions
      • Boolean tools
      • Boolean operations
      • Making regions bool ops
      • Operator precedence
      • Learning boolean operations review
    • Creating a Goblet
      • Goblet New Database
      • Goblet view Data Tree
      • Raytracing Goblet
      • Creating Goblet Review
      • Making Goblet Regions
      • Making Goblet Region Comb
      • Making Goblet Region Comb
    • Assigning Material Properties to Your Goblet
      • Goblet review opening db
      • Goblet assign colors
      • Goblet transparency mirror
      • Goblet newforms Raytrace
      • Goblet material properties review
    • Assigning More Material Properties to Your Goblet
      • Goblet specular diffuse
      • Goblet refractive index
      • Goblet shininess
      • Goblet extinction
      • Goblet emission
      • Goblet shader attributes
    • Goblet material properties2 review
      • Creating a Globe in a Display Box
      • Globe in display newdb
      • Globe create display box
      • Create globe in box
      • Globe assign mater prop
      • Globe move rotate
      • Globe use color tool
      • Globe in display box review
    • Refining the Mug
      • Mug new db
      • Mug outside cyl
      • Mug handle
      • Mug comb1
      • Mug comb2
      • Mug region
      • Mug review
    • Creating the Mug Through the GUI
      • Mug mater prop mater cmd
      • Mug raytrace1
      • Mug refining
      • Mug torus cup combine
      • Refining mug review
    • Creating the Mug Through the GUI
      • Mug gui create body
      • Mug gui create handle
      • Mug gui create rim
      • Mug gui create combinations
      • Mug gui make region
      • Mug gui check tree
      • Mug gui comb edit props
      • Mug gui raytracing
      • Mug through gui review
    • Placing Shapes in 3-D Space
      • candle create tabletop
      • candle create base
      • candle create candle
      • candle create flame
      • candle create combination
      • candle check data tree
      • candle assign mater prop
      • candle raytrace
      • placing shapes in 3d review
    • Gaining More Practice Placing Shapes in Space
      • candle base 1st sphere
      • multipane feature
      • copies of shapes
      • practice make regions spheres
      • candle base spheres combine
      • placing shapes in 3d 2 review
      • candle assign mater prop
      • candle raytrace
      • placing shapes in 3d review
    • Creating a Toy Truck
      • truck cab in cmd
      • truck hood in cmd
      • truck cab wheel well
      • ok accept apply reset cancel dismiss
      • truck wheel well prim edit cpy
      • truck cab shape comb
      • truck body in cmd
      • prim ed wheel wells
      • truck body wheel wells comb
      • truck cab body region
      • truck wheels
      • truck wheels region
      • truck regions mater props
      • on screen help
      • stacker shading
      • using stacker shading
      • truck combine regions
      • truck raytracing
      • creating toy truck review
    • Learning Modeling Techniques and Structures
      • Radio shapes to regions
      • body of radio
      • radio other regions
      • radio assembly comb
      • radio assign mater props
      • radio internal components
      • radio specialty models
      • radio structure redefinition
      • modeling techniques and structures review
  • Man 1
    • Anim Script
    • Anim Sort
    • Anim Time
    • Anim Track
    • Anim Turn
    • AP Pix
    • Asc2dsp
    • ASC2G
    • ASC NMG
    • ASC PLOT 3
    • Azel
    • Bary
    • Benchmark
    • Bot Dump
    • Brep Simple
    • Brlcad
    • BrlCad Config
    • Buffer
    • BW 3 Pix
    • BwCrop
    • BWDfiff
    • BW FB
    • BW Filter
    • Bwhist
    • Bwhisteq
    • Bw Imp
    • Bwmod
    • BW PIX
    • BW PNG
    • BW PS
    • BW Rect
    • BW RLE
    • BW ROT
    • BW SCALE
    • BW Shrink
    • BW STAT
    • BW THRESH
    • CAP Boundp
    • CAD Parea
    • Canonize
    • Cell FB
    • Chan Mult
    • Chan Premute
    • Cmap FB
    • Coil
    • Comgeom G
    • Conv vg2g
    • Cv
    • Cy-g
    • db
    • Db Clean
    • Db cp
    • Decimate
    • Dpix pix
    • Dxf-g
    • enf-g
    • euclid-g
    • Fast4-g
    • Fbanim
    • Fb-bw
    • Fbcbars
    • Fbclear
    • Fbcmap
    • Fb Cmap
    • Fbcmrot
    • Fbcolor
    • Fbed
    • Fbfade
    • FB-FB
    • Fb Frame
    • Fb Free
    • Fb Gamma
    • Fb Grid
    • Fb Help
    • Fb Label
    • Fb Line
    • Fb pix
    • Fb Png
    • Fb Point
    • Fb RLE
    • Fb Scanplot
    • Fb Serv
    • Fb Stretch
    • Fb zoom
    • Fir pass
    • G2asc
    • g-aced
    • Gdiff2
    • G Diff
    • G dxf
    • G-egg
    • Gen Color
    • g-euclid
    • Gif 2 fb
    • Gif Fb
    • g-iges
    • G Lint
    • G-niff
    • G nmg
    • G obj
    • gqa
    • G raw
    • G Shell Rect
    • G Step
    • G-stl
    • G tankill
    • G-var
    • G-vrml
    • G x3d
    • Halftone
    • hex
    • Iges-g
    • Imgdims
    • Irdisp
    • Ir-X
    • Lgt
    • Loop
    • Mac Pix
    • Mged
    • Morphedit
    • Nastran
    • Nirt
    • nmg-bot
    • Nmg-rib
    • obj-g
    • Patch G
    • Pictx
    • Pix 2 asc
    • Pix Alias
    • Pix Autosize
    • Pix Backgnd
    • Pix Gstrip
    • Pix Blend
    • Pix border
    • Pix Bustup
    • Pix Bw
    • Pix Bw 3
    • Pix Clump
    • Pix Cmp
    • Pix Color
    • Pix Cut
    • Pix Diff
    • pix d split
    • Pix Fade
    • Pix fb
    • Pix Filter
    • Pix Halve
    • Pix hist
    • Pix hist3d
    • Pix hist3d Plot3
    • Pix Interp2x
    • Pix Matte
    • Pix Merge
    • Pix Morph
    • Pix Png
    • Pix Ppm
    • Pix ps
    • Pix Rect
    • Pix rle
    • Pix rot
    • Pix saturate
    • pixscale
    • Pix Shrink
    • Pix Stat
    • Pix subst
    • Pix Sun
    • Pixtile
    • Pix untile
    • Plot3 Asc
    • Plot 3 Color
    • Plot 3 debug
    • Plot3-fb
    • Plot 3 get frame
    • Plot 3 hpgi
    • Plot 3 line 2
    • Plot 3
    • Plot3 ps
    • Plot 3 rot
    • Plot 3 tek
    • Plot3 x
    • ply g
    • Png bw
    • Png fb
    • Png Info
    • Png Pix
    • PP FB
    • Proe-g
    • Random
    • Ramapid
    • Remrt
    • Reshoot
    • Rle Fb
    • Rle Pix
    • Rpatch
    • Rt
    • Rtarea
    • Rt Bot Faces
    • Rt Check
    • R Tedge
    • Rt example
    • RTG3
    • RT Hide
    • RT PP
    • Rt Range
    • R Tray
    • Rt Scale
    • Rt shot
    • Rt therm
    • Rt Walk
    • Rt Weight
    • Rt Wizard
    • Rt xray
    • Script sort
    • Sec Pass
    • Shape Fact
    • Show Shot
    • Show Therm
    • Ssamp Bw
    • Stl g
    • Sun Pix
    • tab interp
    • Tab Sub
    • Tankill G
    • Terrain
    • Tire
    • Ug g
    • Vdeck
    • View Point
    • wavelet
    • Wdb Example
  • Man 3
    • Libcursor
    • Lib fb
    • Lib Role
    • Lib Plot3
    • Librt
    • Libwdb
    • Red Black
  • Man 5
    • Attributes
    • bw
    • Cmap
    • Dsp
    • Pix
    • Plot 3
  • Mann
    • 3 Ptarb
    • ADC
    • AE
    • Alias Pix
    • All sf
    • Analyze
    • Aim Cascade
    • Anim Fly
    • Anim Hardtrack
    • Anim Keyread
    • Anim Lookat
    • Animmate
    • Anim Offset
    • Anim Orient
    • Apropos
    • Apropos Devel
    • Apropos Lib
    • Arced
    • Area
    • Arot
    • Attach
    • Attr
    • Auto View
    • B
    • BB
    • Bev
    • Bo
    • Bolt
    • Bot Condense
    • Bot Decimate
    • Bot Face Fuse
    • Bot Face Sort
    • Bot Flip
    • Bot Sync
    • Bot Vertex Fuse
    • Brep
    • Build Region
    • C
    • Cat
    • Center
    • Color
    • Comb
    • Comb Color
    • CopyEval
    • Copy Mat
    • CP
    • CPI
    • D
    • Dall
    • DB
    • DB Concat
    • DB Glob
    • DB Upgrade
    • De Bugbu
    • De Bugdir
    • De Buglib
    • De Bugmem
    • De Bugnmg
    • De Compose
    • Delay
    • DM
    • Draw
    • Dup
    • E
    • EAC
    • Echo
    • E Command
    • Ed Codes
    • Ed Color
    • Ed Comb
    • Ed Gedir
    • Edit
    • Edit Translate
    • Ed Mater
    • EM
    • E Muves
    • EQN
    • Erase
    • Erase All
    • EV
    • Exists
    • Exit
    • Expand
    • Export Body
    • Extrude
    • Eye Pt
    • Face Def
    • Facetize
    • Find
    • Fracture
    • G
    • Garbage Collect
    • Gastank
    • GQA
    • GR
    • Graph
    • Gui
    • Handle
    • Help
    • Help Devel
    • Help Lib
    • Hide
    • History
    • I
    • Idents
    • I Graph
    • ILL
    • IN
    • Inside
    • Introduction
    • ITEM
    • Journal
    • Keep
    • Key Point
    • Kill
    • Kill All
    • Kill Tree
    • Knob
    • L
    • Labelvert
    • Lc
    • Listeval
    • Im
    • I Muves
    • Load Tk
    • Lookat
    • Ls
    • M
    • Make
    • Make Pnts
    • Mater
    • Mat Pick
    • Memprint
    • MirFace
    • Mrot
    • Mv
    • Mvall
    • Nirt
    • NMG Collapse
    • NMG Simplify
    • oed
    • Open DB
    • Orientation
    • Orot
    • Oscale
    • Over Lay
    • P
    • Pathlist
    • Path
    • Permute
    • Picket Fence
    • Plot
    • Pr Color
    • Prefix
    • Press
    • Preview
    • Prj Add
    • Ps
    • Pull
    • Push
    • Put Comb
    • Putmat
    • Q
    • Qorot
    • Qray
    • Query Ray
    • Quit
    • Qvrot
    • R
    • Rcc Blend
    • Rcc Cap
    • Rcc Tgc
    • rcc-tor
    • Rocdes
    • Read Muves
    • Red
    • Refresh
    • Regdebug
    • Regdef
    • Regions
    • Reid
    • Release
    • Rfarb
    • RM
    • Rmater
    • R mats
    • Rot
    • Rotobj
    • Rpp Arch
    • Rpp Cap
    • RRT
    • Rt
    • Rt area
    • Rt Check
    • Save Key
    • Save View
    • Sca
    • Search
    • Sed
    • Set View
    • Shader
    • Shell
    • Show Mats
    • Size
    • Solids
    • Sph Part
    • Status
    • Summary
    • Sv
    • Sync
    • T
    • Ted
    • Title
    • T Muves
    • Tol
    • Tops
    • Tor rcc
    • Tra
    • Track
    • Translate
    • Tree
    • Units
    • Vars
    • Vdraw
    • View
    • Viewsize
    • Vnirt
    • Voxelize
    • Vquery Ray
    • Vrmgr
    • vrot
    • Wcodes
    • What Id
    • WhichAir
    • Which Shader
    • Who
    • Window
    • Window Frame
    • Wire
    • Wmater
    • X
    • Xpuch
    • Z
    • zoom
  • Presentations
    • Application Development with BRL-CAD
    • Introduction To TclTK
  • Specifications
    • BRL-CAD G Format V5
      • Background and Terminology
        • Format of Data Elements Database External Format
      • Definition of a Single, Generic Database Object
        • Object Structure
        • Flags
        • Object Type
        • Object Length
        • Object Name
        • Object Attributes
        • Object Body
        • Padding and Length Rounding
        • How Objects Are Grouped into a Database
        • Details of BRL-CAD-Specific Nongeometric Database Object Types
        • Details of BRL-CAD-Specific Geometric Database Object Types
        • Extensions for Deferred Implementation
        • Community Feedback on the Proposal
        • Database Library Application Programming Interface (API)