RevitSdkSamples/snapshot/2010/SDK_2/Samples/FrameBuilder/CS/ReadMe_FrameBuilder.rtf

{\rtf1\fbidis\ansi\ansicpg936\deff0\deflang1033\deflangfe2052{\fonttbl{\f0\fswiss\fprq2\fcharset0 Arial;}{\f1\froman\fprq2\fcharset0 Times New Roman;}{\f2\fnil\fprq1\fcharset134 Fixedsys;}}
{\colortbl ;\red0\green128\blue0;\red0\green0\blue255;}
\viewkind4\uc1\pard\ltrpar\b\f0\fs20 Application:\b0  FrameBuilder\line\b Revit Platform:\b0  All\line\b Revit Version:\b0  2010.0\line\b First Released For:\b0  9.1\line\b Last Modified:\b0  02/26/2008\line\b Modified By:\b0  CL Autodesk\line\b Programming Language:\b0  C#\line\b Skill Level:\b0  Medium\line\b Category:\b0  Structure\line\b Type:\b0  ExternalCommand\line\line\b Subject:\b0  Create a frame composed of columns, beams and braces.\line\b Summary:\b0  \line This sample demonstrates how to create a frame composed of columns, beams and braces. User can input parameters to create a frame consist of column, beam and brace. It has a user visible option to use the suspended updating function to increase the speed of the model creation. And users can duplicate the type of column, beam and brace.\f1\par
\pard\ltrpar\fi800\par
\pard\ltrpar\b\f0 Classes:\b0  \f1\par
\pard\ltrpar\li360\f0 Autodesk.Revit.IExternalCommand \par
Autodesk.Revit.Elements.FamilyInstance\f1\par
\f0 Autodesk.Revit.Creation.Document \f1\par
\f0 Autodesk.Revit.Elements.Level\par
\lang1024 Autodesk.Revit.Symbols.FamilySymbol\lang1033\f1\par
\pard\ltrpar\par
\b\f0 Project Files:\b0  \f1\par
\f0 Command.cs\par
\pard\ltrpar\li360 The main DLL source file which contains the class Command which implements interface IExternalCommand.\cf1\lang1024\f2  \cf0\f0 Initialize necessary data to create framing and display UI for user's input\par
\pard\ltrpar\fi400\cf1\f1\par
\pard\ltrpar\cf0\f0 CreateFrameForm.cs\f1\par
\pard\ltrpar\fi400\f0 This file contains a class that is the main form to create framing.\f1\par
\cf1\par
\pard\ltrpar\cf0\f0 DuplicateTypeForm.cs\f1\par
\pard\ltrpar\li360\f0 This file contains a class that is the form to duplicate FamilySymbol and edit its name and parameters\par
\pard\ltrpar\cf1\f1\par
\cf0\f0 ErrorMessageException.cs\f1\par
\pard\ltrpar\li300\f0 This file contains a class which passes error message to UI or back to internal error messagebox by Execute method in IExternalCommand.\par
\pard\ltrpar\fi300\f1\par
\pard\ltrpar\f0 FrameBuilder.cs\f1\par
\pard\ltrpar\fi300\f0 This file contains a class which\cf1\f2  \cf0\f0 creates columns, beams and braces to create framing\f1\par
\par
\pard\ltrpar\f0 FrameData.cs\par
\pard\ltrpar\fi400 This file contains a data class which includes information to create framing\f1\par
\par
\pard\ltrpar\f0 FrameTypeParameters.cs\par
\pard\ltrpar\li400 This file contains a class which is used to show and modify parameters of column, beam or brace for control PropertyGrid\f1\par
\pard\ltrpar\fi400\par
\pard\ltrpar\f0 FrameTypesMgr.cs\par
\pard\ltrpar\li400 This file contains a class which is the data manager taking charge of FamilySymbol object in current document\f1\par
\pard\ltrpar\fi-360\li720\tx720\lang1033\f0 -\tab Press the Duplicate button in the dialog;\par
\pard\ltrpar\f1\par
\b\f0 Description:\b0  \f1\par
\f0 This sample provides the following functionality:\par
\pard\ltrpar\fi-360\li720\tx720 -\tab Present a dialog to users asking for the following information:\par
-\tab Distance between columns\par
-\tab Number of Columns in the X direction\par
\pard\ltrpar\fi-360\li720 -\tab Number of Columns in the Y direction\par
-\tab The type of the columns\par
-\tab The type of the beams\par
-\tab The type of the braces\par
-\tab Number of Floors\par
-\tab Incremental height of Auto-generated levels\par
-\tab Coordinate of the bottom left corner of Frame\par
-\tab Angle to rotate Frame in clockwise\par
-\tab The number of floors is less than the number of levels since columns will be inserted from the level below to the level above. For example if the number of floors requested is 3 then there must be 4 levels and the columns will go from Level 1 to 2, Level 2 to 3 and Level 3 to 4. If there is less than 2 levels tell the user 2 levels must be added and exit the command with a failure. If more levels are need, auto-generate levels according to the number of floors. The height between adjoin generated levels equals to the height between the highest 2 levels existed in the project.\par
-\tab Starting with the lowest level and progressing to higher levels, insert columns with the specified type into the project programmatically in an array format based on the number of columns specified in the X and Y directions with the correct specified distance between them. Do this for each floor specified.\par
-\tab Insert beams of the specified type between the tops of each adjacent column in the X and Y direction to form a square grid of beams. Beams are not needed between diagonal columns.\par
-\tab Insert braces of the specified type between the mid point of each column and the mid point of each adjoining beam.\par
-\tab The frame is moved according to the coordinate of the bottom left corner. Then rotate it in clockwise according to the input angle.\par
-\tab Users can create a new concrete element type through duplicating specified type. The work flow is as follows:\par
-\tab Press the Duplicate button in the dialog;\par
-\tab Change name of column\rquote s type and press OK;\par
-\tab Change value for b and h of section in another dialog and press OK;\par
-\tab Similar steps can be followed for concrete and wood beams and braces.\par
\pard\ltrpar\par
\b Instructions:\cf2\b0  \f1\par
\pard\ltrpar\fi-360\li360\tx360\cf0\f0 1.\tab Open Revit Structure.\par
2.\tab Run the command.\par
3.\tab Input the information to create beams, brace and columns, input the angle to rotate (optional).\par
4.\tab In sample\rquote s main UI click the OK button.\par
\pard\ltrpar\fi-360\li360 5.\tab Application will create a frame consist of column, beam and brace.\par
}