Professional Documents
Culture Documents
Revit Model Content Style Guide PDF
Revit Model Content Style Guide PDF
December2009
Version2.1
Copyright 2009 Autodesk, Inc.
All Rights Reserved
This publication, or parts thereof, may not be reproduced in any form, by any method, for any purpose.
AUTODESK, INC., MAKES NO WARRANTY, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY
IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE REGARDING THESE
MATERIALS, AND MAKES SUCH MATERIALS AVAILABLE SOLELY ON AN "AS-IS" BASIS.
IN NO EVENT SHALL AUTODESK, INC., BE LIABLE TO ANYONE FOR SPECIAL, COLLATERAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING OUT OF PURCHASE OR USE OF THESE MATERIALS.
THE SOLE AND EXCLUSIVE LIABILITY TO AUTODESK, INC., REGARDLESS OF THE FORM OF ACTION, SHALL NOT
EXCEED THE PURCHASE PRICE OF THE MATERIALS DESCRIBED HEREIN.
Autodesk, Inc., reserves the right to revise and improve its products as it sees fit. This publication describes the state of the
product at the time of publication, and may not reflect the product at all times in the future.
Autodesk Trademarks
The following are registered trademarks of Autodesk, Inc., in the USA and/or other countries: 3D Props, 3D Studio, 3D
Studio MAX, 3D Studio VIZ, 3DSurfer, 3ds max, ActiveShapes, ActiveShapes (logo), Actrix, ADI, AEC Authority (logo), AEC-
X, Animator Pro, Animator Studio, ATC, AUGI, AutoCAD, AutoCAD LT, AutoCAD Map, Autodesk, Autodesk Envision,
Autodesk Inventor, Autodesk (logo), Autodesk Map, Autodesk MapGuide, Autodesk Streamline, Autodesk University
(logo), Autodesk View, Autodesk WalkThrough, Autodesk World, AutoLISP, AutoSketch, backdraft, Biped, bringing
information down to earth, Buzzsaw, CAD Overlay, Character Studio, Cinepak, Cinepak (logo), cleaner, Codec Central,
combustion, Design Your World, Design Your World (logo), EditDV, Education by Design, gmax, Heidi, HOOPS, Hyperwire,
i-drop, Inside Track, IntroDV, Kinetix, lustre, MaterialSpec, Mechanical Desktop, NAAUG, ObjectARX, Physique, Planix,
Powered with Autodesk Technology (logo), ProjectPoint, RadioRay, Reactor, Revit, Softdesk, Texture Universe, The AEC
Authority, The Auto Architect, VISION*, Visual, Visual Construction, Visual Drainage, Visual Hydro, Visual Landscape, Visual
Roads, Visual Survey, Visual Toolbox, Visual Tugboat, Visual LISP, Volo, WHIP!, and WHIP! (logo).
The following are trademarks of Autodesk, Inc., in the USA and/or other countries: AutoCAD Learning Assistance,
AutoCAD LT Learning Assistance, AutoCAD Simulator, AutoCAD SQL Extension, AutoCAD SQL Interface, AutoSnap,
AutoTrack, Built with ObjectARX (logo), burn, Buzzsaw.com, CAiCE, Cinestream, Civil 3D, cleaner central, ClearScale,
Colour Warper, Content Explorer, Dancing Baby (image), DesignCenter, Design Doctor, Designer's Toolkit, DesignKids,
DesignProf, DesignServer, Design Web Format, DWF, DWFit, DWG Linking, DXF, Extending the Design Team, GDX Driver,
gmax (logo), gmax ready (logo),Heads-up Design, jobnet, ObjectDBX, onscreen onair online, Plans & Specs, Plasma,
PolarSnap, Productstream, Real-time Roto, Render Queue, Visual Bridge, Visual Syllabus, and Where Design Connects.
Autodesk Canada Co. Trademarks
The following are registered trademarks of Autodesk Canada Inc. in the USA and/or Canada, and/or other countries:
discreet, fire, flame, flint, flint RT, frost, glass, inferno, MountStone, riot, river, smoke, sparks, stone, stream, vapour, wire.
The following are trademarks of Autodesk Canada Inc., in the USA, Canada, and/or other countries: backburner, Multi-
Master Editing.
Third Party Trademarks
All other brand names, product names or trademarks belong to their respective holders.
Third Party Software Program Credits
ACIS Copyright 1989-2001 Spatial Corp. Portions Copyright 2002 Autodesk, Inc.
Copyright 1997 Microsoft Corporation. All rights reserved.
Flash is a registered trademark of Macromedia, Inc. in the United States and/or other countries.
International CorrectSpell Spelling Correction System 1995 by Lernout & Hauspie Speech Products, N.V. All rights
reserved.
InstallShield 3.0. Copyright 1997 InstallShield Software Corporation. All rights reserved.
PANTONE Colors displayed in the software application or in the user documentation may not match PANTONE-
identified standards. Consult current PANTONE Color Publications for accurate color.
PANTONE and other Pantone, Inc. trademarks are the property of Pantone, Inc. Pantone, Inc., 2002
Pantone, Inc. is the copyright owner of color data and/or software which are licensed to Autodesk, Inc., to distribute for
use only in combination with certain Autodesk software products. PANTONE Color Data and/ or Software shall not be
copied onto another disk or into memory unless as part of the execution of this Autodesk software product.
Portions Copyright 1991-1996 Arthur D. Applegate. All rights reserved.
Portions of this software are based on the work of the Independent JPEG Group.
RAL DESIGN RAL, Sankt Augustin, 2002
RAL CLASSIC RAL, Sankt Augustin, 2002
RMCSG2 Version2.1
Representation of the RAL Colors is done with the approval of RAL Deutsches Institut fr Gtesicherung und
Kennzeichnung e.V. (RAL German Institute for Quality Assurance and Certification, re. Assoc.), D-53757 Sankt Augustin.
Typefaces from the Bitstream typeface library copyright 1992.
Typefaces from Payne Loving Trust 1996. All rights reserved.
AutoCAD 2006 is produced under a license of data derived from DIC Color Guide from Dainippon Ink and Chemicals,
Inc. Copyright Dainippon Ink and Chemicals, Inc. All rights reserved. DIC Color Guide computer color simulations used
in this product may not exactly match DIC Color Guide, DIC color Guide Part 2 identified solid color standards. Use
current DIC Color Guide Manuals for exact color reference. DIC and DIC Color Guide are registered trademarks of
Dainippon Ink and Chemicals, Inc.
Printed manual and help produced with Idiom WorldServer .
WindowBlinds: DirectSkin OCX Stardock
AnswerWorks 4.0 ; 1997-2003 WexTech Systems, Inc. Portions of this software Vantage-Knexys. All rights reserved.
The Director General of the Geographic Survey Institute has issued the approval for the coordinates exchange
numbered TKY2JGD for Japan Geodetic Datum 2000, also known as technical information No H1-N0.2 of the
Geographic Survey Institute, to be installed and used within this software product (Approval No.: 646 issued by GSI, April
8, 2002).
Portions of this computer program are copyright 1995-1999 LizardTech, Inc. All rights reserved. MrSID is protected by
U.S. Patent No. 5,710,835. Foreign Patents Pending.
Portions of this computer program are Copyright ; 2000 Earth Resource Mapping, Inc.
OSTN97 Crown Copyright 1997. All rights reserved.
OSTN02 Crown copyright 2002. All rights reserved.
OSGM02 Crown copyright 2002, Ordnance Survey Ireland, 2002.
FME Objects Engine 2005 SAFE Software. All rights reserved.
GOVERNMENT USE
Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in FAR 12.212 (Commercial
Computer Software-Restricted Rights) and DFAR 227.7202 (Rights in Technical Data and Computer Software), as
applicable.
Version2.1 RMCSG3
CONTENTS
FeedbackontheGuide7
Audience7
Definition:QualityRevitContent7
Contents8
SupplementaryFiles8
AdditionalFiles9
Section1:PlanningRevitModelContent10
RecommendedRevitReleaseandDisciplineforContentCreation10
1.1DeterminingDesignIntent11
DeterminingtheTemplatetoUse11
FamilyRepresentations12
1.2BalancingPerformanceandDesignComplexity16
DesignIntentvs.Performance16
RecommendedFamilyFileSizes18
LevelofDetail19
ElementVisibility20
AreastoAvoidforOptimumPerformance20
ExamplesofFamilieswithAppropriateandcomplexLevelsofDetail21
ConsiderationsforNestingFamilyContent22
NestingRecommendations:22
1.3AutodeskExchangeFormat(.ADSK)23
AECExchangeEnvironment23
CreatingIntelligentConnectors23
SimplifyingtheGeometricRepresentation24
Publishingtothe.ADSKformat24
reading.ADSKfiles25
ImportingintoRevitFamilies25
Limitations25
1.4UsingImportedContent26
RMCSG4 Version2.1
SupportedContent26
Limitations26
1.5PlanningaRevitModelFamily27
Section2:ModelContentCreationStandards28
2.1WorkflowforModelContentCreation29
Prototyping30
2.2FamilyUnits30
2.3FamilyNamingConventions31
2.4TypeNamingConventions33
2.5CategoryandSubcategoryStandardsandUsage35
AddingSubcategoriesToModelFamilies35
SubcategoryNamingConventions36
2.6AutodeskApprovedParameterUsage37
AddingManufacturerDatatoFamilies38
CSIOmniClassTable4938
CSIClassificationCodes39
AssigningtheMasterFormatandUniFormatClassificationinRevit39
AssigningtheOmniClassclassificationinRevit(Revit2010andlater)40
2.7ParameterNamingConventions41
2.8MaterialNamingConventions44
Guidelines44
FormatForIndividualFinishMaterials(StoredInsideProjects)44
FormatForIndividualFinishMaterialsUsinganExternalImageFile45
FormatForIndividualMaterialsImages(StoredOutSideofRevit)45
2.9PreviewImageStandards46
CreatingAutodeskStandardFamilyPreviewImages47
2.10TypeCatalogStandardsandUsage52
TypeCatalogStandards52
2.11MaterialApplicationinModelFamilies54
Option1ApplyMaterialswiththeMaterialParameter54
Version2.1 RMCSG5
Option2ApplyMaterialstoFamilyGeometrybyCategoryandSubcategory55
Option3ApplyMaterialswithCustomInstanceorTypeMaterialParameters55
Example:AssigningMaterialstoaTableFamily56
2.12BestPracticesforAddingConnectorsinRevitMEPFamilies58
AddingaConnector58
SystemTypes59
ConnectorDirection60
PrimaryConnector60
LinkingConnector61
ConnectorMapping62
ConnectorDescriptions63
Section3:TestingGuidelines64
3.1GeneralFamilyTestingGuidelines65
FamilyEditorTestingCriteria65
ProjectTestingCriteriaforRevitArchitecture66
3.2FamilySpecificTestingGuidelines67
RMCSG6 Version2.1
INTRODUCTION
ThepurposeofthisguideistodefineAutodeskguidelinesandstandardsformodelcontentcreationinRevit
Architecture,RevitMEP,andRevitStructure.Modelcontentreferstothetwodimensionalandthree
dimensionalstandardcomponentfamiliesthatareusedtocreateelementsthatrepresentmanufacturedcontent
(forexample,windows,furnaces,heatpumps,andstructuralsteelmembers).
Byfollowingtheguidelinesandstandardsinthisguide,contentcreatorswillensuretheportabilityand
performanceoftheircontent,andfulfillthenecessarydistributionrequirementsfortheAutodeskSeekweb
service.TheAutodeskSeekwebservicerequires:
theuniformdisplayofproductsofferedbyasinglemanufacturer
complete,consistent,andaccuratepresentationofproductdataacrossmanufacturers
thefulluseofAutodeskSeeksearchcapabilities
FEEDBACKONTHEGUIDE
PleasesendyourcommentsontheRevitModelStyleGuideandsupportingdocumentationto:
rmsg.feedback@autodesk.com
Wecantrespondtocommentsindividually,butfeedbackwillbeconsideredinfutureversionsoftheRevitModel
ContentStyleGuide.
AUDIENCE
Thisguideisintendedformanufacturers,contentserviceorganizations,andothercontentcreatorswhohave
advancedknowledgeofbothRevitsoftwareandRevitmodelcontentcreation.
DEFINITION:QUALITYREVITCONTENT
QualityRevitcontentbalancesperformancewithdesignaccuracyandrequiredlevelsofdetail.Qualitycontentis
easytousebecauseitfunctionsreliablyinarangeofprojectsandprojectphases,whiledeliveringmanufactured
contentinaformatappropriateforarchitectureandengineeringdocumentationdeliverables.
QualityRevitcontentiscreatedwiththefollowingconsiderations:
Designintenttheauthorhasconsideredhowthefamilywillbeusedinaproject.
Appropriatelevelofdetaildesigned
Adequatenumberoftypescreated
Flexibleuseofparameters
Accuracycomplete,consistentpresentationofproductdata.
StandardsadherestoindustryandAutodeskstandards.
Namingconventions
Graphicguidelines
Version2.1 RMCSG7
Parameterusage
Performancecontentdesignedtoreducetheperformanceimpactofthefamilyonaproject.
Testingthoroughtestingofthefamilyparametersandtypesindependentlyandinaproject
environment.
CONTENTS
Section1:PlanningRevitModelContent
Explainshowdesigncomplexityinfamiliescanaffectprojectperformanceandoffersguidelinesfor
reducingperformanceimpact
DetailstherecommendeduseandlimitationsofcontentcreatedwithotherCADsoftware
Providesbestpracticesforplanningmodelcontent
Section2:ModelContentCreationStandards
Describesbestpracticesformodelcontentcreation
ContainsAutodeskstandardsforunits,namingconventions,subcategories,parameters,previewimages,
andtypecatalogs
Section3:TestingGuidelines
Containsgeneralandfamilyspecifictestingguidelinesformodelcontentfamilies.
Notincludedinthisguide:
Detailedfamilycreationinstructions
Standardsforannotationorsystemfamilycreation
Categoryspecificguidelinesforfamilycreation
Indepthbestpracticesforfamilycreation
SUPPLEMENTARYFILES
Thefollowingdocumentsandfilesarereferencedforusewiththisguideandareincludedinthedownload
package.
RevitMasterParameterList.xlsincludesAutodeskapprovedRevitmastersharedparameters
RevitMasterSharedParameterFile.txtincludesAutodeskapprovedsharedparameterstouseinyour
projects
RevitMasterSubcategoryList.xlsincludesAutodeskapprovedRevitsubcategories
RevitMasterPartTypeList.xlsincludesAutodeskapprovedRevitparttypes
RevitModelContentSampleFilesincludessampleRevitmodelcontentandimages
CategoryspecificModelContentGuidesincludescreationguidelinesforspecificcontent
SharingRevitContentonAutodeskSeekincludesdistributionrequirementsfortheAutodeskSeekweb
service.
RMCSG8 Version2.1
ADDITIONALFILES
ThefollowingresourcesareavailableforworkingwithbothRevitmodelcontentandAutodeskSeek.
AUTODESKMETADATASTYLEGUIDEANDPRODUCTWORKBOOK
TheAutodeskMetadataStyleGuidedefinesstylesandformattingrulesthatmanufacturers,contentservice
organizations,andcontentspecialistsmustabidebysothatthecontentthattheyproducecanbeloadedintothe
AutodeskSeekstagingenvironment.
Downloadat:http://seek.autodesk.com/participate.htm.
DOCUMENTATION
FormoreinformationonRevitfamilycontentcreation,seethefollowingreferencemanualsandtutorials:
RevitArchitectureFamiliesGuide
Downloadatwww.autodesk.com/revitarchitecturedocumentation.
RevitArchitecture,RevitMEP,andRevitStructureTutorials
Downloadat:
www.autodesk.com/revitarchitecturedocumentation
www.autodesk.com/revitmepdocumentation
www.autodesk.com/revitstructuredocumentation
DISCUSSIONGROUPS
AUGI(AutodeskUserGroupInternational)
Accessatwww.augi.com.
AutodeskSeekDiscussionGroup
Accessatwww.autodesk.com/contentsearchdiscussion.
Version2.1 RMCSG9
SECTION1:
PLANNINGREVITMODELCONTENT
InordertoensureRevitmodelcontentisdevelopedefficientlyandtoAutodeskstandards,contentcreatorsshould
followAutodeskapprovedbestpracticeswhencreatingRevitfamilies.
Byfollowingtheguidelinesinthissection,youcan:
createRevitfamilycontenteasilyandwithfewererrors
ensureconsistencyandstabilityofRevitfamilycontent
createcontentsuitablefordeliveryonAutodeskSeek
RECOMMENDEDREVITRELEASEANDDISCIPLINEFORCONTENTCREATION
Note:AllsamplefamilyandprojectfileswerecreatedbasedontheRevitPlatform2009release;therefore,they
cantbeopenedinearlierversionsofRevit.
RECOMMENDATION:Toensurethatcontentisavailabletothelargestnumberofendusers,createthecontent
usingAutodeskRevit2009.Contentcreatedinrelease2009canalsobeusedinlaterversionsofRevit.Ifthe
contentrequiresfunctionalityavailableinalaterrelease,thencreatethecontentinthatreleaseofRevit.
UsetheRevitproduct(RevitArchitecture,RevitMEP,orRevitStructure)thatisappropriateforthecontentyouare
creating,forexample,foraDoorfamily,useRevitArchitecture,foranAirHandlingUnit,useRevitMEP.Ifthe
contentcrossesdisciplines,forexample,alightingfixtureorplumbingfixture,usetheproductthathasthemost
requirements,inthiscaseRevitMEP.
RMCSG10 Version2.1
1.1DETERMININGDESIGNINTENT
WhencreatingaRevitfamily,theintendeduseofthefamilyinaprojectenvironmentdeterminestheextentto
whichitisdesigned.Youcandesignallfamiliestoincludeanumberofrepresentationsforuseindifferentproject
viewsandprojectphases.
Thetypeandsizeoftheprojectthatafamilyisintendedforuseinisacriticalpointtoconsiderwhendeciding
whatrepresentationsshouldbeincludedinthefamilyandwhatlevelofdetaileachrepresentationshouldhave.
Themoredetailedafamilyis,thelargeritsfilesizewillbe.Thelargerthefilesize,theslowertheperformance,
loading,andregenerationtimeofthefamilywillbe.Whenconsideringthedesignintentofafamily,usethe
followingguidelines:
Forlargercommercialorinstitutionalprojects,inwhichhundredsofelementsmaybecreatedwitha
singlefamily,designthefamilytobeassmallaspossibletominimizeprojectsizeandperformance
impact.
Forsmallerresidentialprojects,whereelementscreatedwithasinglefamilyarenotusedubiquitously
andwheretheoverallprojectsizeissmaller,designthefamilytoincludemoredetail.
Thenexttopic,BalancingPerformanceandComplexity,addressestheissueoffamilysizeandcomplexityinmore
detail.
DETERMININGTHETEMPLATETOUSE
Forobjectstypicallyhostedbyothercomponents,suchasawindoworlightfixture,startwithahostbased
template.Forexample,forawindowordoor,useawallbasedtemplate,suchasWindow.rftorDoor.rft.Howthe
familyishosted(orwhatitdoesordoesnotattachto)determineswhichtemplateshouldbeusedtocreatethe
family.Ingeneral,thechoiceofatemplateisdrivenbythehostoftheobject,withthefollowingexceptions:
Floorbasedobjectstypicallyusealevelbasedtemplateunlesstheyarerequiredtocutthefloor.For
example,Furnitureobjectsarecreatedwithalevelbasedtemplate.
Forobjectsthataredesignedtobeusedinmorethanonediscipline,suchasplumbingorlightingfixtures,
useahostbasedtemplatethatallowsthegreatestflexibilityforalldisciplines.Forexample,alighting
fixtureusedexclusivelyinanarchitecturaldisciplinecouldbecreatedwithaceilingorwallbased
template,butforanengineeringenvironment,afacebasedtemplateisrequiredforthemodellinking
workflow.Therefore,foralightingfixturethatwillbeusedinbothdisciplines,useafacebasedtemplate.
Version2.1 RMCSG11
FAMILYREPRESENTATIONS
Dependingontheintendeduseofafamily,itmaycontainthefollowingrepresentations:
Schematic(genericcontent;typicallynotmanufacturerspecific;mayincludemultiplelevelsofdetail)
Designdevelopment(manufacturerspecificcontent;typicallyCoarselevelofdetail)
Constructiondocument(manufacturerspecificcontent;typicallyMediumlevelofdetail)
Highqualityrendering(manufacturerspecificcontent;typicallyFinelevelofdetail)
Dependingontheusecaseforthecontent,the3manufacturerspecificrepresentations(Designdevelopment,
Constructiondocument,andHighqualityrendering)maybedevelopedin1or2familyfiles.Forexample,one
familyfilemaycontaintheDesigndevelopmentandConstructiondocumentationrepresentationsofthecontent
andasecondfilemaycontainthehighqualityrenderingrepresentation.TypicallyMEPcontentdoesnotincludea
highqualityrendering,soforthistypeofcontentonefamilyfilemaybecreatedcontainingtheDesign
developmentandConstructiondocumentationrepresentations.
SCHEMATIC
Schematicrepresentationsarecreatedfromtwodimensionallineworkandrepresentthefamilyobjectinitsmost
basicappearance.Theycanbeconsideredplaceholdersforelementsthatwillbeincludedinmoredetailed
designdrawings.Schematicrepresentationsdonotusuallydisplaymaterials.
RMCSG12 Version2.1
Schematicrepresentationsofatoiletfamilyandofatablefamily
DESIGNDEVELOPMENT
Designdevelopmentrepresentationsincludemoredesigndetailthanschematicrepresentations,aswellas3D
forms.Theymayalsoincludebasicmaterials.Dependingontheelementthatwillbecreatedfromthefamily,the
designdevelopmentrepresentationmayincludethefollowingviews,aswellasappropriatelevelsofdetail:
Model
Plan/ReflectCeilingPlan(RCP)
Section/Elevation
TypicallyCoarselevelofdetail
Designdevelopmentrepresentationofawindow:displaysminimaldetail,mullionsarerepresentedbymodellines
Version2.1 RMCSG13
Designdevelopmentrepresentationofawatersoftener:displaysbasicshapesofthesoftenerandshows
connectors
CONSTRUCTIONDRAWING
Constructiondrawingrepresentationsareusuallysymbolictwodimensionalrepresentations.Dependingonthe
elementthatwillbecreatedfromthefamily,theconstructiondrawingrepresentationmayincludethefollowing
viewsaswellasappropriatelevelsofdetail:
Plan/ReflectedCeilingPlan(RCP)
Section/Elevation
TypicallyMediumlevelofdetail
Constructiondocumentationrepresentationofawindow:includesmullionsandswing
RMCSG14 Version2.1
Constructiondocumentationrepresentationofawatersoftener:displaysamorerealisticrepresentationofthe
softeneranditsconnections
HIGHQUALITYRENDERING
Todefinetheappearanceoffamilyelementsinhighqualityrenderings,materialsmustbeassignedtofamily
geometry.Materialpropertiesandlightingmustbedefined.Therenderingistypicallycreatedfroma
representationwithFinelevelofdetailthatincludesobjectsnotusuallyshowninconstructiondrawings,suchas
thehardwareorinlayinthetablebelow.
Highqualityrepresentationofatableinashadedviewandinarenderedimage
Version2.1 RMCSG15
1.2BALANCINGPERFORMANCEANDDESIGNCOMPLEXITY
ThedesigncomplexityofafamilycanaffectitsperformancewhenitisusedtocreateelementsinRevitprojects.
Thisisanimportantconsiderationwhencreatingfamiliesthatincludealotofgeometry,multipleparametric
relationships,and/oralargenumberoffamilytypes(sizes).Efficientgeometrycreation,judicioususeof
parametricconstraints,andcarefullyplanneddetailandvisibilitysettingscanreducetheperformanceimpacta
familywillhaveontheprojectsinwhichitisused.
Inthissection,youlearnto:
Identifypossibleperformancegainsandimpedimentspriortofamilycreation
Managedifferentperformancefactors,includingparametricrelationships,detaillevel,andvisibility
settings
Createefficientfamilies
DESIGNINTENTVS.PERFORMANCE
Themorecomplexanddetailedafamilyis,thelargeritsfilesizeandimpactonperformancewillbe.Before
creatingafamily,determinethefollowing:
Thedesignintentofthefamily:Whataretherepresentationsthatthefamilymustcontain(schematic,
designdevelopment,constructiondocumentation,highqualityrendering),andhowdetailedmusteach
representationbe?
Thetypeofprojectinwhichthefamilywillbeusedandhowfrequentlyitwillbeused:Willthefamily
createonly10elementsinasmallresidentialproject,orwillitbeusedtocreatehundredsofelementson
manyfloorsofalargecommercialbuildingmodel?
RMCSG16 Version2.1
Thefollowinggraphdisplaysthegeneraltrendfortheimpactofdesigncomplexityonfilesize.Generallythemore
representationsafamilyhasandthemoredetailedtheyare,thelargerthefamilyfilesize.Thelargerthefamilyfile
sizeis,themoreofanimpactitwillhaveonperformance(longerloadingandregenerationtimesandgreater
increaseinprojectfilesize).
ImpactofDesignComplexityandProjectSizeonFamilyFileSize
Forexample,awindowfamilythatisintendedtobeusedhundredsoftimesinalargecommercialprojectwillhave
asmallerfilesizeifitcontainsonlybasicschematicanddesigndevelopmentrepresentations.Impactonthe
projectsizewillbeasminimalaspossible.
Conversely,adifferentwindowfamilyintendedforuseinasmallresidentialprojectmaycontainahighquality
renderingrepresentationthatwillincreaseprojectfilesizewhenthefamilyisadded,butbecausethewindowsit
createsareaddedtotheprojectonlyafewtimes,theincreaseinfilesizeismanageable.
Version2.1 RMCSG17
RECOMMENDEDFAMILYFILESIZES
Toprovidecontentcreatorswithatangibleguidelineforfamilyfilesize,somecommonfamilytypesandtheir
recommendedfilesizesarelistedbelow.Usethefilesizesbelowasarecommendation,asactualsizemayvary.
Large,complex,and/orunusualfamiliesmayexceedtheserecommendations.
IMPORTANT:Tohelpreducethefilesize,inRevit,clickFilePurgeUnusedtodeleteitemsthatarenotinuse,
clickFilemenuSaveAs,andverifythattheCompactFileoptionisselectedwhensavingthefile.
RMCSG18 Version2.1
LEVELOFDETAIL
Detaillevelsdeterminewhichpiecesoffamilygeometrydisplayindifferenttypesofprojectviews.WhenaRevit
elementiscreatedwithafamilyandaddedtoaprojectview,thecurrentdetailleveloftheview(coarse,medium,
orfine)displaystheappropriatefamilygeometry.
INTENT:Theintentistobuildthefamilybasedontheexpectedfinerepresentation,thenremovedetailtocreate
thelowerlevelsofdetail.Thisapproachimprovestheperformanceofthefamilyinlowerlevelsofdetailviewsin
theproject,butstillprovidestherequiredgraphicsforproperdocumentationofaproject.Theintentisnotto
buildeachlevelofdetailincrementallyoradditionally.
AwindowdisplayedinbothCoarseandFinedetail
Familiesthatincludeintricatelevelsofdetailcanimpedeperformancewhenusedinprojects.Foroptimalfamily
performance,onlythenecessaryfamilygeometryshouldbemodeledandtheuseofhighlydetailed
representationslimited.
Whendecidingwhatlevelofdetailshouldbeshown,usethefollowingrecommendations:
Dontmodelgeometrythatwillnotbevisiblewhenthefamilyisaddedtoabuildingmodel.
Forexample,foratablefamilythatincludesadrawer,modelthefaceonly,nottheentiredrawer.
Dependingonthetypeoffamily,usethefollowingguidelinewhenmodelinggeometry:
Ifthegeometryis Setthedetaillevelto
Smallerthan1 Fine
13 Medium
Largerthan3 Coarse
Donotduplicategeometrythatcanbeusedfordifferentlevelsofdetail.
Version2.1 RMCSG19
ELEMENTVISIBILITY
Typically,thegeometryofanelementcreatedbyafamilywillchangedependingonthecurrentprojectview.The
visibilitysettingsofthefamilydetermineinwhichprojectviewselementscreatedwiththefamilywilldisplay.
Inaplanview,youmaywanttoseea2Drepresentationoftheelement.Ina3Dorelevationview,youmaywant
todisplayafullydetailed3Drepresentationoftheelement.Inotherviews,youmaywanttohidetheelement.
Limitingthevisibilityofhighlydetailedfamilygeometrytoonlycertainviewscanimproveprojectperformance.
AREASTOAVOIDFOROPTIMUMPERFORMANCE
Usethistableasaguidetoimprovetheperformanceofyourfamilies.
CommonMistakeWhenCreatingFamilies RecommendedApproach
Lackofplanningpriortofamilycreation Beforecreatingafamily,usetheguidelinesoutlinedin
1.4PlanningaRevitModelFamily.
Unnecessaryparametricrelationships Beforeaddinggeometrytoafamily:
Plantheparametricrelationshipsandcreatea
familyskeletonthatfeaturesthemain
parametricrelationships.
Buildonlytheparametricfamilybehaviorthat
youneedtoavoidoverconstrainingthe
model.
Flextheskeletontotesttherelationships
beforeyouaddgeometry.
Useofgeometryinsteadofsymboliclinesinplanviews Inplanviewrepresentations,geometryusuallycanbe
representedwithsymboliclines,ratherthan(solid)
geometry.Usinggeometryinsteadofsymboliclineswill
createanunnecessarilylargerfamily.
Highlevelsofgeometricdetailandunderuseofvisibility UsetheguidelinesintheLevelofDetailandElement
settings Visibilitysectionsofthisguidetoavoidunnecessarily
largefamilyfiles.
Overuseofvoids,formulas,andarrays Extensiveuseofvoids,formulas,andarrayswilladdto
theoverallfamilysizeandaffectitsperformancein
projects.
Useoftoomanynestedfamilies(familiesimportedinto Nestfamiliestocreategeometryinotherfamilies only
otherfamilies) whennecessary.Onlyusenestedcontenttoshare
objectsamongmultiplefamilies,forexample,door
hardware,muntinpatterns,andsoon.
Largefamilieswithmanytypesthatdonotincludetype Themoretypes(particularlyunused)theheavierthe
catalogs family.Createtypecatalogsforfamiliesthatcontain6
ormoretypes.See2.10TypeCatalogStandardsand
Usage.
Inadequatefamilytesting See 3.1 GeneralFamilyTestingGuidelines.
RMCSG20 Version2.1
EXAMPLESOFFAMILIESWITHAPPROPRIATEANDCOMPLEXLEVELSOFDETAIL
ThepurposeofcreatingRevitfamiliesformanufacturedcontentisnotforthemanufacturingprocess,butfor
architectureandengineeringdocumentationdeliverables.Itisimportanttocreatethefamilycontentatan
appropriatelevelofdetailfortheintendeduse.Thefollowingexamplesofawindowfamilyillustratethisguideline.
Ineachofthefollowingimages,thewindowontheleftincludesanappropriatelevelofdetailandthewindowon
therightincludesmoredetailthanisrequiredorusefulfortheproject.
PLANVIEW
NOTE:Theaboveimageshowstypicalgraphicqualityforaplanviewscale.Noticethemuddyqualitytothe
windowontheright.
PLANVIEWENLARGED
SECTIONVIEW
Version2.1 RMCSG21
CONSIDERATIONSFORNESTINGFAMILYCONTENT
Anestedfamilyisonethathasbeenloadedintoanotherfamily.Insomecases,itcanbeconvenienttorepresent
partsofthenestedfamilyseparatelyfromthemainfamilymodel.Forexample,youcouldcreateawindowsill
familyandnestitinawindowfamily.Thisallowsyoutobuilduponpreviousworkwhilecreatingfamiliessuitedto
yourneeds.
IMPORTANT:Itisimportanttounderstandthatnestingfamiliesincreasesthefilesizeandaffectsperformance,
specificallytheregenerationprocessofthefamilyviews.
NESTINGRECOMMENDATIONS:
Insteadofnesting,considercreatingallofthenecessarygeometryinthefamily.Usereferencelinesand
labelstolockgeometryinplace.
Limitnestingto2levelsThedeeperthatfamiliesarenested,thelongertheytaketoupdateinthe
projectfile.
Onlynesthighvaluecontentthatmaybeusedinseveraldifferentfamilies,suchasadoorhandle.
Becarefulwhenchanginganestedcomponentthatissharedbymorethanonefamily.Whenyoureload
thecomponentintotheprojectfileitwillupdateallofthefamiliesinthefilesharingthesamenested
family.
RMCSG22 Version2.1
1.3AUTODESKEXCHANGEFORMAT(.ADSK)
Startinginthe2010releaseofAutodeskproducts,theAutodeskExchangeformat(.ADSK)providesanimproved
methodformanufacturerstoleverageDigitalPrototypestoproduceRevitFamilies.TheInventor2010AEC
ExchangeenvironmentprovidesmanufacturerswiththeabilitytoprovidetheirexistingDigitalPrototypesas.ADSK
files,whichcancontainasimplified3Dgeometricrepresentation,intelligentconnectors,andotherproduct
metadatathatcanbereadbyRevitArchitecture2010,RevitMEP2010,AutoCADArchitecture2010,andAutoCAD
MEP2010software.ByreusingtheinformationfromexistingCADdesigns,manufacturersandtheircustomerscan
avoidthetimeandexpenserequiredtoremodelthisdata.
AECEXCHANGEENVIRONMENT
TheAECExchangeenvironmentisavailableinInventor2010andlaterversions,andthecommandsforpreparing
andpublishingcontentareavailabledirectlywithintheInventoruserinterface.Thecontentpreparationand
publishingprocessinvolves:
Creatingintelligentconnectors
Simplifyingthegeometricrepresentationoftheproductdesign
Addingproductmetadatainformation
Publishingthedesigntothe.ADSKformat
CREATINGINTELLIGENTCONNECTORS
TheAECExchangeenvironmentsupportsthedefinition
ofpiping,ducts,andelectricalconnectors,whichallow
theAECApplicationUsertoconnecttheADSKsourced
contenttoBuildingServicesintheirdesigns.
Theseconnectorsareassignedpropertiesthatare
relevanttotheirusage(e.g.,flowdirectionand
quantityofairflowforaduct),whicharerequiredfor
connectiontotheirrespectiveBuildingServices.
Version2.1 RMCSG23
Figure1 ElectricalConnectorsonanHVACUnit
SIMPLIFYINGTHEGEOMETRICREPRESENTATION
AsthetypicalDigitalPrototypeismodeledaround
manufacturinglevelofdetail,itissuggestedthata
modelsimplificationworkflowbeusedtodramatically
simplifyandreducethelevelofdetailthatisprovided
toAECCustomers.
Withoutmodelsimplification,thehighlevelofdetail
thatcanbepresentinaDigitalPrototypewillhavean
adverseimpactonmodelperformanceintheAEC
application.Userscancontrolthelevelof
simplification,rangingfromremovalofkeyinternal
detailstoacompleteshrinkwrapthatrepresents
onlytheouterenvelopeoftheproductdesign.The
shrinkwrapprocessenablesthecreationofa Figure2DetailedGeometryofanHVACUnit
simplifiedgeometricrepresentationofthebuilding
productwhileretainingtheinformationthatisdesiredbyarchitectsandengineers.Theprocesscanalsohelp
protecttheIntellectualpropertythatmanufacturersdonotwishtodisclosetodownstreamcustomers,byallowing
forselectivedeterminationoffeaturesandgeometrytobeincludedorexcludedduringtheprocess.
Figure3Simplifiedrepresentation
PUBLISHINGTOTHE.ADSKFORMAT
Thepublishingprocessinvolvesexportingtherelevantgeometry,connectors,andproductinformationtothe
.ADSKfile.Usershavetheoptiontoexportrelevantproductmetadata(e.g.,producttype,model,manufacturer,
cost,andcustom).TheproducttypeclassisbasedontheOmniClassTable23AECIndustryTaxonomy.Direct2D
viewrepresentationsofthe3Dgeometrycanalsobeincluded.
RMCSG24 Version2.1
READING.ADSKFILES
The.ADSKformatcanbereadbyRevitArchitecture2010,RevitMEP2010,AutoCADArchitecture2010,and
AutoCADMEP2010softwareversionsorlater.Informationfromthe.ADSKfilecanbeincorporatedintothe
receivingapplicationandsavedoutintheapplicationsnativeformat.
IMPORTINGINTOREVITFAMILIES
ADSKfilesthencanbeimportedintoRevitFamiliesforsomepostprocessingtohelpmeettherequirementsofthe
RevitModelContentStyleGuide.Thisprocesswillbediscussedinmoredetailinafutureappendix.
LIMITATIONS
TherearelimitationstoADSKsourcedcontentwhichshouldbeunderstoodinordertomaximizethevaluefor
manufacturersandtheirspecifyingAECcustomers.Notethatsomeoftheselimitationscanbemitigatedwithpost
processingoftheADSKfilesafterithasbeenconsumedbyRevit.
AsaresultofthemodelsimplificationprocessinInventoranddifferencesbetweentheInventorandAEC
productsParametricgeometryhandling,thegeometrythatiscurrentlyproducedforAECapplications
throughtheAECExchangeEnvironment,isstatic,andcannotbeediteddirectlybytheAECuser.Itwill
appearasimportedgeometry.
ADSKfilesdonotcurrentlycontainvisualappearanceinformation,andthereisnowaywithinRevit
productstomanuallymodifytheirappearance.
ADSKfilesdonotcurrentlysupportRevitHostingbehavior,andthereforethecontentcannotbeplaced
onFacesofBuildingElements,orhaveholescutinthem.IntegratingthecontentintoaRevitfamily(.rfa)
filecanhelpremovethislimitation.
LightSourceDefinitionscannotcurrentlybedefinedinADSKfiles,andthusmustbemanuallyaddedin
theRevitenvironmentifneeded.IntegratingthemintoaRevitfamily(.rfa)filecanhelpremovethis
limitation.
Asaresultofcurrentlimitations,ADSKfilesaremosteffectivefordeliveringconfiguredengineeringproductsthat
donotrequireahighlevelofvariabilityforusebytheenduser.
Version2.1 RMCSG25
1.4USINGIMPORTEDCONTENT
ContentcreatedinotherCADformatsmaybeimportedandusedtocreateRevitfamilycontent.Importedcontent
mayincludegeometry,metadatasuchasproductperformanceinformation,connectors,andviews.Theuseof
suchimportedgeometrydoesnotofferallofthecapabilitiesavailablewiththe.ADSKformat(seeSection1.3)but
isanoptionif.ADSKdataisnotavailable.
WhenimportinggeometryfromotherCADformats,foroptimalresultsandintegralfamilyfunctionality,itis
recommendedthattheimportedgeometryisusedasaguideforfamilycreation,notasthefamilygeometryitself.
NOTE:ItisacceptabletouseimportedgeometryforcontentthatisdifficulttocreategeometricallyinRevit,such
aspeople,trees,cars,etc.
SUPPORTEDCONTENT
RevitfamiliessupporttheimportofcontentcreatedinthefollowingCADfileformats:
.DWG (AutodeskAutoCADformat)
.DXF (AutoCADDrawingInterchangeFormat)
.SAT (SpatialCorporationStandardACISformat)
.SKP (GoogleSketchUpModelformat)
LIMITATIONS
Ifyouimportcontentintoafamilyanduseittocreatethefamilywithoutmodification,theresultingfamilytypes
willbeaddedtobuildingmodelsasstaticelementsthatdonotsupportthedynamicparametricrelationships
inherentinRevitbuildingmodels.Familiescreateddirectlyfromimportedcontentdonotsupportdirect
assignmentofmaterialsandotherparameters,limitingtheiroveralluseintheprojectenvironment.Imported
contentmayalsohaveadverseeffectsonprojectperformance.Insomecases,theselimitationsmaybe
acceptable,buttoconformtostandardbuildinginformationmodelingpractice,itisrecommendedthatmost
importedcontentshouldberecreatedasafullyfunctionalRevitfamily.
RMCSG26 Version2.1
1.5PLANNINGAREVITMODELFAMILY
Beforefamilycreationbegins,carefulupfrontplanningofthefamilyshouldbeperformed,evenforthesimplestof
families.Planningfamiliespriortocreationcansavetimeandpreventerrors.
Willthefamilyneedtoaccommodatemultiplesizes?
Forawindowthatisavailableinseveralpresetsizes,orabookshelfthatcanbebuiltinanylength,create
astandardcomponentfamily.
Howshouldthefamilydisplayindifferentviews?
Thewaytheobjectshoulddisplayinviewsdeterminesthe3Dand2Dgeometrythatyouneedtocreate,
aswellashowtodefinethevisibilitysettings.Determinewhethertheobjectshoulddisplayinaplanview,
elevationview,and/orsectionalviews.
Doesthisfamilyrequireahost?
Forobjectstypicallyhostedbyothercomponents,suchasawindoworlightfixture,startwithahost
basedtemplate.Howthefamilyishosted(orwhatitdoesordoesnotattachto)determineswhich
templatefileshouldbeusedtocreatethefamily.
Howmuchdetailshouldbemodeled?
Insomecases,youmaynotneed3Dgeometry.Youmayonlyneedtosketcha2Dshapetorepresentyour
family.Also,youmaysimplifythe3Dgeometryofyourmodeltosavetimeincreatingthefamily.For
example,lessdetailisrequiredforawalloutletthatwillonlybeseenininteriorelevationsfroma
distance,thanforadoorwithraisedpanelsandasidelightthatwillbeseeninaninteriorrendering.
Whatistheinsertion/originpointofthisfamily?
Theinsertion/originpointisthepointatwhichyouwanttoplacethefamilyinaproject(indicatedbythe
cursorposition).Theinsertionpointmaychangebasedonusecase.Forexample,theinsertionpointfor
windowsanddoorsisthecenterofthegeometry,sothatthecontentparametricallyexpandsfromthe
centerout.Foracountertop,theinsertionpointisatacornerandthecontentexpandswiththeinstance
lengthinonedirection.Determiningtheappropriateinsertionpointwillhelpusersplacethefamilyina
project.
Version2.1 RMCSG27
SECTION2:
MODELCONTENTCREATIONSTANDARDS
InordertoensureRevitmodelcontentisdevelopedefficiently,consistently,andtoAutodeskstandards,content
creatorsshouldfollowtheAutodeskapprovedstandardsinthissectionwhencreatingRevitfamilies.
Usethetopicsinthissectionto:
ensureconsistencyandstabilityofyourRevitfamilycontent
ensureaconsistentuserexperience
createcontentsuitabletoshareonAutodeskSeek
RMCSG28 Version2.1
2.1WORKFLOWFORMODELCONTENTCREATION
Beforeyoucreateamodelfamily,reviewthestandardsinthissection,andthenusethebestpracticeworkflow
belowtocreateyourcontent.Thisworkflowhelpstoensurethatyourcontentiscreatedinthemostefficientand
leasterrorpronemanner.
1. Createanewfamilyfile(.rfa)withtheappropriatefamilytemplate.
2. Definesubcategoriesforthefamilytohelpcontrolthevisibilityofthefamilygeometry.
3. Createthefamilyskeleton,orframework:
Definetheorigin(theinsertionpoint)ofthefamily.
Layoutreferenceplanestosnaptowhenyousketchcomponentgeometry.
Adddimensionstospecifyparametricrelationships.
Labeldimensionstocreatetypeorinstanceparametersor2Drepresentation.
Test,orflex,theskeleton.
4. Definefamilytypevariationsbyspecifyingdifferentparameters.
5. Addasinglelevelofgeometryinsolidsandvoids,andconstrainthegeometrytoreferenceplanes.
6. Flexthenewmodel(typesandhosts)toverifycorrectcomponentbehavior.
7. Repeatpreviousstepsuntilthefamilygeometryiscomplete.
8. Specify2Dand3Dgeometrydisplaycharacteristicswithsubcategoryandentityvisibilitysettings.
9. Savethefamily,andthentestit.
10. Forlargefamiliesthatincludemanytypes,createatypecatalog.
TIP:Formoreinformationonthestepsinthisworkflow,downloadtheRevitArchitecture2009FamiliesGuide
(www.autodesk.com/revitarchitecturedocumentation),andseetheCreatingStandardComponentFamiliestopic.
Version2.1 RMCSG29
PROTOTYPING
Ifyouneedtocreateanumberofsimilarfamilies:
1. Planandcreateasingleprototypefamily.
2. TesttheprototypefamilyintheFamilyEditorandinaprojectenvironmenttoidentifyanyerrorsor
inconsistencies.
SeeSection3:TestingGuidelinesfortestingcriteria.
3. Correctanyerrorsandinconsistenciesandretestthefamilytoensureitisworksproperlybeforecreating
theadditionalfamilies.
2.2FAMILYUNITS
Althoughfamiliescanbecreatedasunitspecific(imperialormetric),Revitsoftwarestoresallcoordinatesin
universalunitsanddisplaysspecificunitsaccordingtouserpreference.Thismeansthat:
Unitscanbesettodisplayasnecessaryforatargetaudience(i.e.,displayasdecimalunitsforacivil
engineeringdrawingorfractionalunitsforanarchitecturaldrawing).
Familiescreatedinimperialunitsmaybeloadedintoandusedinmetricprojectsandviceversa.
Forinformationonchangingthedisplayofunits,seeProjectUnitsintheRevitHelp.
Touseanimperialormetricfamilyinaprojectwithdifferentbaseunits,useoneofthefollowingoptions:
Loadthefamilyintheprojectwhereitwillusethecurrentprojectunits.
However,anyimperialormetricspecifictextinthefamilyname,typenames,andparameternameswill
stilldisplayasmetricunlessexplicitlychanged.Standardssizesmayalsoneedtobeadjusted.
Duplicatethetypeswithinametricorimperialfamilytocreatebothimperialandmetrictypeswithinthe
family.
Openthefamily,saveitasanewfamily,andchangetheunits.
RMCSG30 Version2.1
2.3FAMILYNAMINGCONVENTIONS
FamilynamesaretheprimarymeansofidentifyingfamiliesinAutodeskSeekandintheRevitsoftware.Autodesk
familynamingconventionsensurethatfamiliescanbeidentifiedinAutodeskSeekandtheRevitsoftwarebythe
realworlditemsthattheycreate.Thenamingconventionsincludedescriptorsthatallowtheusertosearchfor
familiesbyelement,bymanufacturer,and/orbaseunits.
GUIDELINES:
Createuniquenamesforeachfamily.
Forexample,afixedwindowfamilyandafixeddoorfamilycannotsharethesamename.
Usenaturallanguagetonamethefamily.
Thefamilynameshoulddescribehowthefamilyisidentifiedintherealworld(i.e.,incatalogs,by
manufacturer,etc.).
Ifpossible,donotincludethefamilycategoryinthefamilyname,unlessthefunctionaltypeisthesame
asthecategory(e.g.,window).
Usetitlecasing(aswiththetitleofabook)forfamilynames,astheyarecasesensitive.
Keepfilenamesasshortaspossible.
FamilynamesmustdisplayindialogsandintheTypeSelector.
Whenaddingoptionaldescriptorstofamilyfilenames,considertheorderinwhichthedescriptorsare
listedtoensurethatthefamilyfilesdisplayintheProjectBrowserinthemostlogicalandintuitiveorder.
Do not use spaces between words in file names. To separate words within a syntax element (e.g.,
ManufacturerorDescriptor),usetheunderscorecharacter(_).
If a hyphen () is used to include a performance range, enclose the range in parentheses, for example,
(230250_Ton).
Ifatypecatalogistobeusedwithafamily,namethetypecatalog(.txtfile)withthesamenameasthe
family.Seesection2.10foradditionalinformation.
FORMAT
<FunctionalType><Subtype><Manufacturer><Descriptor1><Descriptor2><2Difnecessary>
Note:RefertotheRevitMasterPartTypeList(includedinthedownloadpackage)forinformationonapproved
FunctionTypesandSubtypes.
Descriptionoffields:
Version2.1 RMCSG31
Examples
WindowDouble_HungAcmeTilting_SashClad.rfa
ChillerAir_CooledAcmeLow_Profile.rfa
FountainDrinkingAcmePolished_Chrome.rfa
WindowDouble_HungGenericWood.rfa
ChillerAir_CooledAcmeScroll(75100_Ton)Pkgd.rfa
RMCSG32 Version2.1
2.4TYPENAMINGCONVENTIONS
Allfamiliesmustincludeonepredefinedtype.Forfamiliesthatcreaterealworldobjectsthatareavailablein
standardsizes,predefinedtypesshouldbegenerated.Unlesstheyrepresentnominalsizes,typenamesshould
includeunitsorcapacity,andincludeaunitindicator.
Whennamingafamilytype,usetheformatandrulesbelow:
GUIDELINES
Donotincludethefamilynameorcategoryinthetypename.
Typenamesshouldmirroractualusage.
Typenamesshouldindicatethekeydifferencesbetweentypes(size,count,material)and,when
applicable,reflectstandardsizes.
Insomecases,youmaybasenamesonsizedifference,butusecommontermsratherthannumbers.
Whentypesarenamedbysize,usedimensionsonly.
Avoidtheuseofcharactersorwords.(h,w,d,orheight,width,depth).
Typenamesshouldincludeunitsorcapacityandaunitindicator,unlesstheyrepresentnominalsizes.
Metrictypesshouldreflectthelocalunitstandard,unlessthetypesareintendedtobegeneric.
Keeptypenamesasshortaspossible.
TypenamesmustdisplayindialogsandintheTypeSelector.
FORMAT
Unlessthereisamarketspecificreasontodootherwise,usethefollowinggeneralorderintypenames:
Fordoorsandwindows: <width>x<height>
Forcaseworkandfurniture: <width>x<depth>x<height>
Forotherelementtypes: <width>x<depth>
Version2.1 RMCSG33
Forunitspecificfamilies:
Forimperialfamilytypes:
Inmostcases,sizeshouldbeexpressedininches.Useonlyoneoftheconventionsbelowwithinafamilyand
forrelatedfamilies.
Forfamilieswithmostsizesunder10: XXxYY
Forfamilieswithmostsizesover10: XXYYxAABB
Formetricfamilytypes:
Foralltypesinmetricfamilies: XXXXxYYYYmm(orlocalmetricunitindicator)
Forfamiliesthatfeaturenominalsizesorindustrystandardterms:
Intypenames,dropthedimensionindicators(,,ormm)and/oruseindustrystandardnamingconventions.
Brick(industrystandardnaming): Common,Norman,CSR,MetricModular
Lumber(nominalsizes): 2x4
Structure(industrystandardnaming): W12x204
EXAMPLES
TYPESFORANIMPERIALWINDOW:
16x24
16x48
24x24
24x48
24x72
36x24
36x48
36x72
RMCSG34 Version2.1
2.5CATEGORYANDSUBCATEGORYSTANDARDSANDUSAGE
Allfamilies,includinggenericfamilies,mustbeassignedtoappropriatecategoriesandsubcategories.Whena
familyiscreated,itisassignedacategory.Thecategorydefinesitstoplevelofidentification(forexample,Door,
Window,orCasework)withintheprojectenvironment.Whenthefamilyisusedinaproject,thefamilycanbe
locatedintheProjectBrowserunderitscategory,andelementscreatedbythefamilytypeswillschedulebyits
category.Thelineweight,linecolor,linepattern,andmaterialassignmentofthefamilygeometrycanalsobe
assignedtobycategory.
Todisplaydifferentlineweights,linecolors,linepatterns,andmaterialassignmentsfordifferentgeometric
componentsofthefamily(forexample,theframe,sash,mullions,andglassthatcompriseawindow),the
componentscanbeassignedtosubcategorieswithinthefamilycategory.
CategoriesarepredefinedinRevitsoftwareandcannotbecreatedorchangedbytheuser.Subcategoriesare
predefinedinsomefamilies,butothersubcategoriescanbecreatedinfamiliesasneeded.
ADDINGSUBCATEGORIESTOMODELFAMILIES
Ifyouneedtoaddsubcategoriesinyourfamilies,usethestepsbelowtoensurethatyoursubcategoriesadhereto
Autodeskstandards:
1. OpenthelistofAutodeskapprovedsubcategories,RevitMasterSubcategoryList.xls(includedinthe
downloadpackage).
2. Selecttheworkbookthatcorrespondstothecategoryofthefamilythatyouarecreating.
Thefirsttablecontainsanypredefinedsubcategoriesthatareestablishedbythefamilytemplate.The
secondtablelistsadditionalsubcategoriesthatyoucanuse.
Version2.1 RMCSG35
3. Determineifanyoftheadditionalsubcategoriesfityourneeds.
4. Ifthelistdoesnotcontainthesubcategoriesthatyouneed,createnewsubcategoriesusingthenaming
conventionsinthenextsection.
5. SubmityoursubcategoriestotheAutodeskSeekteamforapproval.Aftertheyareapproved,the
subcategorieswillbeaddedtothemasterlist.
SUBCATEGORYNAMINGCONVENTIONS
Createuniquenamesforeachsubcategory.
Usenaturallanguagetonamethesubcategory.
Thesubcategorynameshoulddescribehowthesubcategoryisidentifiedintherealworld(i.e.,in
catalogs,bymanufacturer,etc.)
Donotincludethefamilycategoryinthesubcategory.
Keepsubcategorynamesasshortaspossible.
Capitalizetheleadinglettersofthewordsthatformthesubcategoryname.
RMCSG36 Version2.1
2.6AUTODESKAPPROVEDPARAMETERUSAGE
Familiescontainparametersthatnotonlycreatethefamilygeometry,butidentifyorclassifytheelementsthatare
createdbythefamily.Allfamilieshavepredefinedparametersthatyouassignvaluesordatato,butyoucanadd
parametersthatarenotpredefinedinRevitsoftware(thatarenotsystemparameters).
IMPORTANT:Ifyouwanttodisplaythenamesandvaluesofcustomparametersinaschedule,theymustbe
definedassharedparametersinatextfilethatisindependentoffamilyandprojectfiles.
REQUIREMENT:Topromoteconsistencyinmodelcontent(particularlyformanufacturercontentthatissharedon
AutodeskSeek),useparametersastheyareexplicitlydefined(includingtheGUID)intheapprovedshared
parametersfile.Ifarequiredparameterisnotinthefile,addittoyourcontentasnecessary.Itisalso
recommendedtoincludethesharedparameterfilecontainingtheadditionalparameterswithyourcontent
package.Whencreatingcustomparameters,referto2.7ParameterNamingConventions.
Refertothemastersharedparametersfile(RevitMasterSharedParameters.txt)forthelistofAutodeskapproved
sharedparameters.Thisfilecontainsmostofthesharedparametersthatyouwillneedtoaddtoyourfamilies.A
spreadsheet(RevitMasterParameterList.xls)thatliststheseparametersbyfamilycategory,alongwithapplicable
predefinedsystemparametersisalsoavailableforyourreference.
WindowscategoryintheRevitMasterParameterList
Version2.1 RMCSG37
ADDINGMANUFACTURERDATATOFAMILIES
IdentityDataparametersinfamiliescanincludemanufacturerdata,includinginformationsuchasthemodel,
description,assemblycode,cost,andmanufacturerURL.Whenelementsarecreatedwiththefamilyinaproject,
theparametersandassociatedvaluescanbeincludedinschedules.
Identitydataparametersforawindowthatincludevaluesformanufacturerdata
CSIOMNICLASSTABLE49
FamilyparameterscanreferenceOmniClassTable49properties,althoughRevitparametersandOmniClass
propertiesmaynotmatchperfectly.SeeRevitMasterParameterList.xlstoviewthemappings.
RMCSG38 Version2.1
CSICLASSIFICATIONCODES
OnAutodeskSeek,contentfamiliescanbelocatedbytheappropriateCSI(ConstructionSpecificationsInstitute)
code.Forbestresults,includeinformationin3formatstandards:
MasterFormat200450divisionsthatstandardizeinformationinconstructionprojectmanuals.
UniFormatII(AssemblyCode)Organizingpreliminaryconstructioninformationbasedonitssystemsand
assemblies.Usedforpreliminaryprojectdescriptions,performancespecifyingandcostestimation.
OmniClass1.0Consistsof15tables,eachrepresentingadifferentfacetofconstructioninformation.
Formoreinformationonthestandards,refertotheCSIWebsite,http://www.csinet.org/s_csi/index.asp.
ASSIGNINGTHEMASTERFORMATANDUNIFORMATCLASSIFICATIONINREVIT
TheMasterFormat2004andUniFormat(AssemblyCode)shouldbeassignedtoeachfamilytype.
1. OpentheFamilyTypesdialogforthefamily.
2. UnderIdentityData,forKeynote,entertheMasterFormatcodeappropriateforthefamilycontent.Refer
totheCSIWebSiteforalistofclassificationcodes.
3. UnderIdentityData,forAssemblyCode,clickintheValuefield,andclickthebrowsebuttontoselectthe
appropriateAssemblyCodefromthedialog.
4. Repeattheprocedureforeachtypeinthefamily.
Version2.1 RMCSG39
ASSIGNINGTHEOMNICLASSCLASSIFICATIONINREVIT(REVIT2010ANDLATER)
TheOmniClass1.0codeisassignedtothefamily.Youdonotneedtoassignittoeachfamilytype.
5. InRevit,OpentheFamilyCategoryandParametersdialog.
6. UnderFamilyParameters,forOmniClassNumber,clickinthefield,andclickthebrowsebuttontoselect
theappropriateOmniClasscodefromthedialog.
NoticethattheOmniClassTitlevalueisaddedautomatically.
RMCSG40 Version2.1
2.7PARAMETERNAMINGCONVENTIONS
ConsistentparameternamingenableseasierandmorecomprehensiveparametricsearchinginAutodeskSeek.
Createparametersonlywhenvariationcreatesmeaningfullydifferentiatedtypesthatrepresentrealworld
possibilities.
GUIDELINES
Usestandardapprovedparameternameswhenavailable.
Keepparameternamesasshortaspossible.
Avoidabbreviationandtruncation,whenpossible.
Usetitlecasing(aswiththetitleofabook)forparameternames,astheyarecasesensitive(e.g.,
CoefficientofPerformance;PointofShipment;HighandLowPressureGasConnectionDiameter).
Parametersmustdisplayindialogs.
DonotchangelabelnamesprovidedbytheRevitfamilytemplates.
Parameternamesthatyoureusetocreateequalitiesshouldbecarefullycheckedfornamecoherence.
Usethemostcommondescriptorforagroupofparametersasthefirstpartofthenamesothatthe
parameterssortlogically(e.g.,FilterFaceArea;FilterEfficiency).
Parametersforsubsequentitemsshouldincludeanumberinthenamebeforethefinalpartofthe
description,butdonotincludeanumberinthenameforthefirstitem(e.g.,ActualHotGasFlow;Actual
HotGas2Flow).
Avoidusingsymbolsinparameternames,including:+/\*()<>|^${}[].
Donotincludeunitsinthenameofaparameter(e.g.,SupplyAirFlowCFM).
UsingthetermsActualorDesign:
o Actualdescribestheactualvaluethesystemdefinitionrequires.Actualparametersarelinked
toconnectorsandareoftenusedforparametersthatdefineflowrates,forexample,Actual
SupplyAirFlow;ActualChilledWaterFlow.
o Designdescribeswhattheproductisdesignedtodo,forexample,DesignVentilationAirFlow;
DesignReturnAirFlow.
NameYes/NoparameterssotheyimplythattheyreturnaYes/Novalue,forexample:
o HasHandle
o IsEnergyEfficient
o ShowHoods
Version2.1 RMCSG41
FORMAT
<Function/Object><Typeofmeasurement/Descriptor>
<Function/Object> requirediftheparameterappliestoasubcomponentratherthan
theentirefamily.
<Typeofmeasurement/Descriptor> requiredforallparameterstodescribethevaluebeingpassed.
EXAMPLES
PARAMETERSTHATAPPLYTOTHEENTIREFAMILY
Format:<Typeofmeasurement/Descriptor>
Casementwindow:
Height
DefaultSillHeight
Width
WindowInset
RoughWidth
RoughHeight
Engineeringequipment:
ActualHeaterGasFlow
TotalHeatingCapacity
FullLoadCurrent
CompressorType
PARAMETERSTHATDESCRIBEAMEASUREMENTVALUEOFASUBCOMPONENT:
Format:<Function/Object><TypeofMeasurement/Descriptor>
HeatPumpCoilFaceArea
HeatPumpCoilFaceVelocity
ExhaustFanBladeSpeed
ExhaustFanDrive
ExhaustFanMotorSpeed
RMCSG42 Version2.1
PARAMETERSTHATDESCRIBETHELINEARDIMENSIONOFASUBCOMPONENT(CONNECTOR)
Format:<Function/Object>Connection<TypeofMeasurement/Descriptor>
HotGasBypass2ConnectionDiameter
CondenserWaterConnectionDiameter
SupplyAirConnectionWidth
SupplyAirConnectionHeight
Version2.1 RMCSG43
2.8MATERIALNAMINGCONVENTIONS
Finishmaterialnamingconventionsorganizethematerialbymanufacturer,andgeneraldescriptiontomore
specificdescription.Dependingonthetypeofmaterial,afinishmaterialnamemayincludeacolor,code,finish
type,oridentificationnumber.
GUIDELINES
Finishnamesshouldindicatethekeydifferencesbetweenmaterials(manufacturer,type,color,
finish)and,whenapplicable,reflectstandardsizes.
Insomecases,youmaybasenamesonsizedifference,butusecommontermsratherthannumbers.
Metricfinishnamesshouldreflectthelocalunitstandard,unlessthematerialsareintendedtobe
generic.
Keepfinishnamesasshortaspossible.
RECOMMENDATION:Tooptimizethefilesizeforfamilieswithalargenumberofavailablematerials,provideonly
themostcommonmaterialsinthefamily,andprovidetheremainingmaterialsinaseparatefinishlibrary.Seethe
Finishesparttypeguideformoreinformation.
FORMATFORINDIVIDUALFINISHMATERIALS(STOREDINSIDEPROJECTS)
<FinishType><Manufacturer><Code><Descriptor>
EXAMPLES
PaintAcmePaintAC440VintageBrownMatte
GlassAcmeGlazingSeries1205Clear
AluminumAcmeMetalAC120Anodized(Clear)
FabricAcmeFabricsACF820HoundstoothBlack/White
StainAcmeWindowsNaturalWoodFinish
RMCSG44 Version2.1
FORMATFORINDIVIDUALFINISHMATERIALSUSINGANEXTERNALIMAGEFILE
Materialsrequiringexternalimages,bumpmapsandcutoutshouldbestoredinalocationthatcanbesharedby
multipleRevitProductinstalls.
ForWindowsXP:
C:\DocumentsandSettings\AllUsers\ApplicationData\RevitManufacturerLibrary\Materials\<MFG>
ForWindowsVistaandWindows7:
C:\ProgramData\AllUsers\ApplicationData\RevitManufacturerLibrary\Materials\<MFG>
GUIDELINES:
Createuniquenamesforeachuniquematerialimage.
Capitalizetheleadinglettersineachportionofthefamilyname.
Donotusespacesbetweenwordsinfilenames.Toseparatewordswithinasyntaxelement(e.g.,
ManufacturerorDescriptor),usetheunderscorecharacter(_).
Acceptablefileformatsformaterialimagesinclude:bmp,jpg,jpegandpng.
ProvideareadmetodescribewheretheimagefilesmustbelocatedandhowtomapRevittotheRevit
ManufacturerLibraryfolderintheRenderingOptionsdialog.
FORMATFORINDIVIDUALMATERIALSIMAGES(STOREDOUTSIDEOFREVIT)
MaterialImage:
<FinishType><Manufacturer><Code><Descriptor>+fileextension
Bumpmaps:
<FinishType><Manufacturer><Code><Descriptor>bump+fileextension
Cutouts:
<FinishType><Manufacturer><Code><Descriptor>cutout+fileextension
EXAMPLES
ImageFile:
PaintAcme_PaintAC_440Vintage_Brown_Matte.jpg
StainAcme_WindowsNatural_Wood_Finish.jpg
BumpImageFile:
bump.jpg
StainAcme_WindowsNatural_Wood_Finishbump.jpg
Cutouts/Perforations:
cutout.jpg
AluminumAcme_FencingAC120Anodizedcutout.jpg
Version2.1 RMCSG45
2.9PREVIEWIMAGESTANDARDS
Afamilypreviewimageisareducedthumbnailimageofa2Dor3Dfamilyviewthatgraphicallyidentifiesafamily
beforeitisdownloadedoropened.Previewimagesdisplayin:
ThumbnailsviewinMicrosoftWindowsExplorer
AutodeskSeeksearchresults
thePreviewwindowinRevitOpenandLoadFamilydialogswhenafamilyisselected
BycreatingpreviewimagesthatadheretoAutodeskstandards,userscanviewconsistentpreviewsacrossfamilies,
ensuringaconsistentuserexperiencebothinAutodeskSeekandinRevitsoftware.
FamilypreviewimagesinAutodeskSeek,WindowsExplorer,andRevitOpenFamilydialogs
RMCSG46 Version2.1
CREATINGAUTODESKSTANDARDFAMILYPREVIEWIMAGES
Tocreateapreviewimage,beginbycreatingafamilyviewtouseexclusivelyforthepreviewimage.Althoughyou
cansaveanyfamilyviewasthepreviewimageview,thebestpracticeistocreateaviewthatcanbesetto
consistentlydisplayasisrequiredforthepreviewimage.
Afteryoucreatetheview,setAutodeskstandardgraphiccontrolsinthepreviewimageviewtoensurevisual
consistencywiththepreviewimagesofotherRevitfamilies.Differentgraphicstandardsexistforthefollowing
typesoffamilypreviewimages:
Detailcomponentandannotationfamilies
Hostedmodelcomponentfamilies
Nonhostedmodelcomponentfamilies
NOTE:Althoughannotationfamiliesarenotcoveredinthisguide,similarstandardsforannotationpreview
imagesexist.
IMPORTANT:Whenmodificationstothepreviewimageviewarecomplete,savetheviewandsetthefamilytouse
thecurrentviewasthepreviewimage.Eachtimeyousaveandclosethefamily,youmustensurethatthepreview
imageviewistheactive(open)viewsoitwilldisplayasthepreviewimage.
CREATINGADETAILCOMPONENTPREVIEWIMAGE
Foraneasilyidentifiabledetailcomponentpreview,setthepreviewimagetodisplaythe2Dviewthatfeatures
onlythecomponentlineworkandfilledregions.
Turnoffvisibilityofdimensionsandreferenceplanes/linesintheview,astheseelementsmayobscurecomponent
geometryiftheydisplay.
Version2.1 RMCSG47
TOCREATEADETAILCOMPONENTPREVIEWIMAGE:
Createaviewtouseasthefamilypreviewimage
1. Ifnecessary,openthedetailcomponentfamilyforwhichyouwanttocreateapreviewimage.
Turnoffvisibilityofdimensionsandreferenceplanes/lines
2. ClickViewmenuVisibility/Graphics.
3. IntheVisibility/GraphicOverridesdialog,clicktheAnnotationCategoriestab.
4. UnderVisibility,clearDimensions,Levels,ReferenceLines,andReferencePlanes.
5. ClickOK.
SetstandardviewcontrolsinthePreviewview
6. OntheViewControlBar:
Clickthecurrentviewscale,anddependingonthefamilyunits,click11/2=10or1:5.
ClickDetailLevel,andclickFine.
ClickModelGraphicsStyle,andclickWireframe.
7. ClickSave.
RMCSG48 Version2.1
CREATINGAHOSTEDORNONHOSTEDMODELCOMPONENTPREVIEWIMAGE
Dependingonthetypeofmodelcomponentthatapreviewimagedepicts,itmaydisplaya2Dorisometricview.If
thepreviewimageiscreatedforahostedfamily,hostelementsmayormaynotdisplayinthepreview.
Thistopicpresentsgeneralguidelinesforcreatingpreviewimages.Foradditionalguidelines,refertothecategory
specificdocumentationformodelcomponentpreviewimages.
Createpreviewimageviewsaccordingtothefollowinggeneralguidelines:
Doorandwindowpreviewimagesshoulddisplaya2Dfrontexteriorelevationviewofthefeatured
component.Visibilityofthehostelement(usuallyawall)shouldbeturnedofftobetterdisplaythe
windowordoor.
Thispreviewimageofawindowfamilyisagoodexamplebecauseithasanappropriatelevelofdetail,isa2D
frontview,andisrepresentativeofthecontent:
Thispreviewimageofawindowfamilyisapoorexamplebecauseitisa3Dviewthatincludesthehostobject
(wall)whichmakesthewindowdifficulttosee:
Othermodelcomponentpreviews,suchasfurnitureorcasework,shoulddisplayinasoutheastisometric
view.
Version2.1 RMCSG49
Hostbasedfamiliesotherthandoorsandwindows,suchaslightfixtures,mayincludehostelements
(wallsorceilings)inthepreviewimage.
Turnoffvisibilityofdimensionsandreferenceplanes/linesintheview,astheseelementsmayobscure
componentgeometryiftheydisplay.
TOCREATEAMODELCOMPONENTPREVIEWIMAGE:
Createaviewtouseasthepreviewimage
1. Ifnecessary,openthefamilyforwhichyouwanttocreateapreviewimage.
2. IntheProjectBrowser,selectaviewofthefamilythatyouwanttouse:
Foradoororwindowfamily,selectanelevationview(preferablyfront).
Forothermodelcomponentfamilies,selecta3Dview.
3. Rightclicktheviewname,andclickDuplicateViewDuplicate.
4. Renametheduplicateview:
IntheProjectBrowser,rightclicktheviewname,andclickRename.
TypePreviewandclickOK.
ClickNotoretainthenamesofcorrespondingviewsandlevels.
5. Ifnecessary,opentheview.
Setastandardpreviewimagevieworientation
6. Dependingonthetypeofcomponentthatyouarecreating,setthevieworientation:
Foradoororwindowfamilyinanelevationview,ontheViewCube,click .
Forotherfamiliesthatdisplayina3Dview,ontheViewCube,click tosetasoutheast
orientation,rightclick,andclickSetCurrentViewasHome.
Turnoffvisibilityofdimensionsandreferenceplanes/linesandifnecessary,setthehostvisibility
7. ClickViewmenuVisibility/Graphics.
8. IntheVisibility/GraphicOverridesdialog,clicktheAnnotationCategoriestab.
9. UnderVisibility,clearDimensions,Levels,ReferenceLines,andReferencePlanes.
10. Ifyouarecreatingapreviewforahostbasedfamily,setthehostvisibility:
Forfamilypreviewsinwhichthehostshouldnotdisplay,suchasdoorsandwindows,clearall
hostcategories.
RMCSG50 Version2.1
Forfamilypreviewsinwhichthehostshoulddisplay,selectallhostcategories.
11. ClickOK.
SetstandardviewcontrolsinthePreviewview
12. OntheViewControlBar:
Clickthecurrentviewscale,anddependingonthefamilyunits,click11/2=10or1:5.
ClickDetailLevel,andclickFine.
ClickModelGraphicsStyle,andclickShadingwithEdges.
Setthepreviewimagetodisplaythecurrentview
13. ClickFilemenuSaveAs.
14. IntheSaveAsdialog,inthelowerrightcorner,clickOptions.
15. IntheFileSaveOptionsdialog,underPreview,forSource,select3DView:Preview,thenselect
Regenerateifview/sheetisnotuptodate.
IMPORTANT:Thissettingdisplaystheselectedviewasthepreviewimage.Itisalsorecommendedthatthe
activeviewwhenyousavethefileisthesameastheselectedpreviewview.
TIP:SelecttheCompactFileoptiontohelpreducethefilesize.
16. ClickOK.
17. ClickSave.
Version2.1 RMCSG51
2.10TYPECATALOGSTANDARDSANDUSAGE
AtypecatalogiscommadelimitedTXTfilethat,whenplacedinthesamedirectoryasafamily,displaysalistof
familytypesbeforethefamilyisloadedintoaproject.Youcanselectandloadonlythefamilytypesthatthe
currentprojectrequires,avoidinganunnecessaryincreaseinprojectsizefromunusedtypesandalonglistoftypes
intheTypeSelector.Thetypecatalogalsoprovidesanexternalmeansofeditingthefamily,asyoucanremoveand
addparametersandtypesinthecatalogfile(TXT).
TYPECATALOGSTANDARDS
Usethefollowingstandardswhencreatingtypecatalogs:
Useanytexteditortocreatetypecatalogs.
Createtypecatalogsforfamiliesthatcontainsixormoretypes.
Nameatypecatalogfile(.txt)withthesamenameasthefamilyfile(.rfa)thatitsupports.
Ensurethatparametersintypecatalogsaretestloadedbythefamilyforwhichyoucreatethetype
catalog.Iftheparametersarenotused,thefamilywillnotload.
IMPORTANT:InTypeCatalogs,inordertoincludefeetandinchmarksinthetypename,youmustincludeamark
afterthefootorinchsymbol.
Todisplaythetypename Inthetypecatalog,enter
48x60 48x60
36 3 6
Forinformationoncreatingatypecatalog,seeCreatingTypeCatalogsintheRevitHelpandFamiliesGuide.
UNITSPECIFICFAMILY
Atypecatalog(TXTfile)foradoorfamily
RMCSG52 Version2.1
Dialogdisplayedbythetypecatalogwhenthedoorfamilyisloaded
STRUCTURALCONTENTINDUSTRYSTANDARDNAMING
Atypecatalog(TXTfile)forasteeljoistfamily
Dialogdisplayedbythetypecatalogwhenthesteeljoistfamilyisloaded
Version2.1 RMCSG53
2.11MATERIALAPPLICATIONINMODELFAMILIES
Materialscanbeappliedtofamiliestodepicttherealworlddisplayofelementscreatedwiththefamilyinshaded
andrenderedviews.
IMPORTANT:Whenapplyingmaterialstoafamily,rememberthatmaterialsincreasethefamilysize,whichin
turndecreasesitsperformancewhenitisloadedandusedinprojects.
Dependingonhowyouapplymaterialstoafamilysgeometry,youcancontroltheusersabilitytomodifythe
materialsofelementsthattheycreatewiththefamily.Usetheseguidelinestoapplymaterialstofamilygeometry:
Ifyouwantto Then
usematerialsthatwillnotneedtobechanged Applythematerialdirectlytothefamilygeometryby
assigningittotheMaterialparameter(Option1).
changethematerialforthefamilycategory Applyamaterialtothefamilycategory.
and/orforsubsetsofgeometriccomponentsin
thefamily Createsubcategories,assignmaterialstoeach
subcategory,andassignsubcategoriestogeometry
(Option2).
changethematerialforageometriccomponentin Createaninstanceortypematerialparameterand
afamilybyinstanceortype assignittotheappropriatefamilygeometry(Option3).
NOTE:Thisisthemostflexibleandpreferredmethodof
materialassignment.
Ifpossible,usethematerialsthatareavailableintheRevitsoftwarewhenassigningmaterialstofamilygeometry.
Ifyouneedtocreateamaterial,makesurethatthematerialnameconformstothenamingconventionsdescribed
intheMaterialNamingConventionstopic.
OPTION1APPLYMATERIALSWITHTHEMATERIALPARAMETER
YoucanapplymaterialsdirectlytosomeorallofthefamilygeometryintheFamilyEditor.Eachpieceoffamily
geometryhasadefaultMaterialparametertowhichyoucanassignmaterials.
USETHISMETHODWHEN:
Thematerialofthefamilygeometryisunlikelytochange,suchasforamanufacturedcomponentthatissupplied
withasinglestandardmaterial.
RMCSG54 Version2.1
RESULT:
Whenyoucreateelementsinaprojectwiththefamily,youcannot:
changetheelementmaterialswithouteditingthefamily
changethematerialforinstancesortypesofthefamily
changethematerialsbyassigningamaterialtotheelementcategory
OPTION2APPLYMATERIALSTOFAMILYGEOMETRYBYCATEGORYANDSUBCATEGORY
Youcanapplymaterialstoallorselectpiecesoffamilygeometrybysubcategory.Subcategoriesarecategoriesthat
existwithinthefamilycategory.Youcanassigndifferentpiecesoffamilygeometrytoeachsubcategory,andthen
applyadifferentmaterialtoeachsubcategory.Toapplymaterialtogeometrythatisnotassignedtoa
subcategory,youcanapplymaterialsbythefamilycategory.
USETHISMETHODWHEN:
Youwanttobeabletoapplydifferentmaterialstodifferentfamilycomponentsbycategoryorsubcategory.
RESULT:
Whenyoucreateanelementinaprojectwiththefamily,
youcanchangethematerialsassignedtoeachsubcategoryorcategory.
OPTION3APPLYMATERIALSWITHCUSTOMINSTANCEORTYPEMATERIALPARAMETERS
Youcancreateandassignacustominstanceortypematerialparametertofamilygeometry.
BESTPRACTICE:Thisisthemostflexiblemethodofmaterialassignmentthatyoucanprovidetheuser.
USETHISMETHODWHENYOUWANT:
toallowtheusertochangefamilymaterialsbyinstanceorbytype.
bysettingthematerialparameterto<bycategory>thisoptioncanalsoallowtheelementstobeupdated
bysubcategoryorcategory.
RESULT:
Whenyoucreateanelementwiththefamilyinaproject,theparametergivesyoutheoptiontochangeamaterial
foraninstanceoftheelementorforeachtypeofelementthatyoucreate.
Version2.1 RMCSG55
EXAMPLE:ASSIGNINGMATERIALSTOATABLEFAMILY
Inthisexample,acombinationofmaterialoptionsisusedtoapplymaterialsinasimpletablefamily.
Materialassigneddirectlytogeometry(Option1):Thehardwarewillnotneedtochangewhenthisfamilyisused
inaproject,soamaterialisapplieddirectlytotheknobforthetabledrawer.IntheElementPropertiesdialogfor
theknobgeometry,underMaterialsandFinishes,theMaterialparametervalueissettoMetalChrome.
Materialsassignedwithtypematerialparameters(Option3):Twotypematerialparametersarecreatedinthe
tablefamily:
LegMaterialassignedtoablackpaintfinish
TopMaterialassignedto<ByCategory>
RMCSG56 Version2.1
Thematerialforthetablelegscanbechangedasrequiredbytheuserintheproject.InElementProperties,the
MaterialpropertyforthetablelegsgeometryisassociatedwiththeLegMaterialfamilyparameter.Thematerial
forthelegsthereforeisdeterminedbythematerialassignedtotheLegMaterialparameterintheFamilyTypes
dialog.
Thematerialforthetabletopcanbechangedbytheuserasrequiredtomatchotherfurniturecomponentsinthe
project.TheMaterialpropertyforthetabletopgeometryisassociatedwiththeTopMaterialfamilyparameter.
ThematerialforthetabletopisthereforedeterminedbythematerialassignedtotheFurniturecategoryinthe
ObjectStylesdialog(inthisexample,Walnut).
Byusingamaterialfamilyparameterandassigningthevalueof<ByCategory>toit,yougivetheusertheflexibility
ofusingthedefaultmaterialappliedtothefamilycategoryorchangingtheparametervaluetoamaterialoftheir
choice.
Version2.1 RMCSG57
2.12BESTPRACTICESFORADDINGCONNECTORSINREVITMEPFAMILIES
InRevitMEP,theconnectorconnectsthesinglefamilycomponentwithothercomponentstocreateMEP
systems.Withoutaconnector,anRMEfamilywouldjustbeastaticplaceholder.
InRevitMEP,thereare3kindsofconnectors:
ElectricalConnector
DuctConnector
PipeConnector
ADDINGACONNECTOR
1. Clickthetoolfortheconnectoryouwishtoadd(ElectricalConnector,DuctConnector,orPipe
Connector).
2. Clicktoplacetheconnectorinthedrawingarea.
RMEprovidestwowaystoplacetheconnector,placingitonafaceoronaworkplane.Ifyouselectthe
PlaceonFaceoption,theconnectorisautomaticallyaddedtothecenterofthefaceofthegeometryand
moveswiththeface.Ifthegeometryisdeleted,theconnectorisalsodeleted.
BESTPRACTICE:Placeconnectorsonafaceratherthanonaworkplane.
RMCSG58 Version2.1
SYSTEMTYPES
Thefollowingtableprovidesanoverviewoftheapplicationscenarioforeachsystemtype.
HydronicReturn CoolingTower
Sanitary Plumbingfixtures Lavatories,
DomesticHotWater WaterClosets.
DomesticColdWater
FireProtectionWet Thethreesystemsarematchingthethree Sprinkler,
FireProtectionDry sprinklersystems,sprinklerwet,sprinklerdry, DryValve
FireProtectionPreAction sprinklerpreaction.
FireProtectionOther Otherfireprotectionsystemsexceptthethree Cabinet,Hose
above,suchasstandpipe Connection
Fitting PipeFittings Elbow,Tee
Global Familiesthatwillbeinmultiplesystems Pump,Valve
Other Familiesingas,refrigerant systems, Gasconnectorof
Placeholderforpipesystemsnotincluded Waterheater
Unsupported StromDrainage ,SanitaryVentilation
SupplyAir HVACAirdeliverysystems AirConditioner,
DuctConnector
ReturnAir DustCollector
ExhaustAir
OtherAir Placeholderforairsystemsnotincluded
Fitting DuctFittings Elbow,Tee
Global Familiesthatwillbeinmultiplesystems Fan
Unsupported FreshAir
Data Automaticallyormanuallycontrolthe DataOutlet
ElectricalConnector
transmitting,receiveorsendingofdata/voice
signals.
PowerBalanced Equipment,deviceorfixtureoperatesin Generator
PowerUnbalanced powersupply/distributionsystems. PanelBoard
Telephone Telecommunicationdevicesusedtotransmit Telephoneoutlet
andreceivesound.
Security Bearmedanddetectsecurity/accessproblem SmokeDetector
FireAlarm Alarminitiatingdevicesoperatetocontrol WaterFlow
alarmsignals Indicator
NurseCall Keycomponentinaddressingpatientcare CallPoint
needs.
Controls Normallyusedforremotecontrolinsome ControlValve
specialcircumstances
Communication Devicesincommunicationsysteminbuilding, Speaker
usedtotransmitting,receiveorsend
communicationsignals
Version2.1 RMCSG59
CONNECTORDIRECTION
Forduct/pipeconnectors,anarrow,perpendiculartothesurface,displays.Thedirectionthatthearrowispointing
isalsothedirectioninwhichtheconnectingduct/pipewillbedrawn.Asthepictureshows,verticalductcanbe
drawnfromanupconnectorinanairterminal.
NOTE:Thearrowdoesnotrepresenttheflowdirection.
PRIMARYCONNECTOR
Bydefault,thefirstconnectorineachdomainisassignedastheprimaryconnector.Inthefollowingimage,youcan
easilyidentifytheprimaryconnector(connector1)bythecrosssymbol.TheReassignPrimarytoolallowsyouto
reassigntheprimaryconnector,asrequired.
Theprimaryconnectorofpipeandductfittingsshouldbelocatedatcoordinates(1,0,0).Inthefollowingimage
oftheplanviewofaPTrap,connector1istheprimaryconnector.
RMCSG60 Version2.1
Forotherfamilies,thelocationoftheprimaryconnectorisnotimportant.
LINKINGCONNECTOR
Whentherearemorethanonepipe/ductconnectors,thereisachoiceforlinkingconnectors.
Linkedconnectorsonlyhaveaneffectwhenthesystemtypeissettoglobalforequipmentorfitting.
Linkingconnectorsonequipmentmakesitpossibletopropagateengineeringdata,allowingyoutouse
equipmentasaninlinecomponentinasystem.
Linkingconnectorsonfittingsshouldincludetheprimaryconnector.
Version2.1 RMCSG61
CONNECTORMAPPING
EditElementPropertiesfortheconnectortodefineparametersfortheconnector.
Forpartparameters,clickingabrowsebuttondisplaysadialogthatmakesiteasytomapconnectorparametersto
familyparameterswiththesameunits.Connectormappingmakestheconnectorparametricwiththefamily.
RMCSG62 Version2.1
CONNECTORDESCRIPTIONS
Inthefollowingexampleofcomplexequipment,itwouldbedifficulttodeterminethefunctionofeachconnector.
Tomakeiteasiertoidentifythefunctionofconnectorsinthefamily,addconnectordescriptions.These
descriptionsdisplayintheSelectConnectordialog.Inthefollowingimage,descriptionsareunderlinedinredfor
illustrationpurposes.
Version2.1 RMCSG63
SECTION3:
TESTINGGUIDELINES
ToensurethequalityofRevitfamilycontent,thoroughlytestfamiliesbeforeusingtheminproductionorsharing
themonAutodeskSeek.Testfamilieswiththeguidelinesinthissectionto:
verifythatnewfamilycontentmeetsAutodeskstandards
ensurefamilyparametricrelationships
ensureaconsistentuserexperience
Twosetsoftestingguidelinesareincluded:generalguidelinesandfamilyspecificguidelines:
Usethegeneralfamilytestingguidelinestotestallfamilies.
Usethefamilyspecifictestingguidelinestotestspecificcriteriaperfamilytype.
Inaddition,categoryspecifictestingguidelinesareavailableforsomefamilycategories.Thesedocumentscontain
specifictestingguidelinesthatyoushouldusewhenavailable.Beforetestingafamily,determinewhethera
categoryspecificdocumenthasbeenpublishedforthecategoryofthefamilythatyouaretesting.
RMCSG64 Version2.1
3.1GENERALFAMILYTESTINGGUIDELINES
Performgeneraltestingonafamilywhenitis:
openintheFamilyEditor
loadedintoaproject
Usethecriteriainthechecklistsbelowtotestfamiliesineachoftheaboveenvironments.
Whentestingfamiliesinprojects,itisstronglyrecommendedthatyou:
Testfamiliesinprojectscreatedwiththegenericmetricandimperialtestingtemplateprojectsthatwere
includedinthedownloadpackage.
Testfamiliesinprojectsthatmatchthedesignintentofthefamily.
Forexample,testawindowfamilythatisdesignedtobeplacedinalargecommercialbuildinginalarge
commercialproject.
ContentthatisdesignedtoworkinmorethanoneRevitdisciplinemustbetestedinallapplicable
disciplines.Forexample,foralightingfixture,testtheconnectorsinRevitMEP,andverifythatthefixture
castslightasexpectedwhenrenderinginRevitArchitecture.
TIP:Forlargecontentcreationprojects,itisrecommendedthatspotcheckingorrandomtestingof10%ofthe
contentbeperformedbyatesterwhoisnotthecontentcreator.
FAMILYEDITORTESTINGCRITERIA
R Testallfamilyparameterstoensurethatthegeometryflexes/adjustscorrectlywhenthefamily
parametersaremodified.
R Testallfamilytypeschangethetype,applyit,andinspectthegeometrytoverifythatthedimensions
andrelationshipsaremaintained.
R Inahostbasedfamily,verifythatthehostflexesasexpected.Changethehostthicknessandensurethat
thefamilygeometryadjustsappropriately.
R VerifythatthefamilypreviewimageisusingthePreviewview.
R Checkallviewstoensurethatthefamilydisplaysappropriatelyindifferentdetaillevelsandwhen
differentModelGraphicsstylesareapplied.
R Testconstraints:
o Testthehandlesontheedgeofthegeometryandmakesurethatallgeometryisconstrainedto
eitherareferenceplaneorareferenceline.
o Testthedimensionparametertomakesurethatthereferenceplaneorlineisbeingadjustedby
theparameterandnottheactualgeometry.
Version2.1 RMCSG65
PROJECTTESTINGCRITERIAFORREVITARCHITECTURE
R Usingatestprojectoroneofthetestingtemplateprojectsavailablefordownload,loadthefamilyina
projectenvironment,andcheckallviewsforanomalies.Ifthefamilyincludesatypecatalog,useittoload
thefamily.
R Inspectthefamilyappearanceinallviews(plan,reflectedceilingplan,elevation,Section,3D)at
alldetaillevels(Coarse,Medium,Fine).
R InspectthefamilyappearanceindifferentModelGraphicsStyles:Wireframe,HiddenLine,
Shading,andShadingwithEdges.
R Testallfamilytypeschangethetype,applyit,andinspectthegeometrytoverifythatthedimensions
andrelationshipsaremaintained.
R Createnewtypesandmodifyallparameters,checkingallviewsforanomalies.
R Modifyallmaterialassignmentstoverifythatmaterialsareassociatedtothegeometrycorrectly.
TIP:Tobetterinspectfamilygeometry,modifyallmaterialtypeparameterstoglass.Also,ifanyofthe
familygeometrydoesnotdisplayasglass,thenamaterialparameterisassignedincorrectly.
R Modifycategoryandsubcategorymaterialstoverifythefamilyisnotusingmaterialtypeparameters.
R Forhostedfamilies:
R Placehostedfamiliesintotheprovidedhostthicknessesandconfirmfamiliesworkinallhosts
appropriatetothefamiliesuse,includinginplacewallsandmasselements.
R Modifythehostthicknessby25%400%,andcheckforunconnectedgeometryand/orplan
representationsthatmaybedisconnectedfromthegeometry.
R Reinspectthefamilyappearanceinallviewstoensurethatthegeometrydisplaysasexpected.
R Dimensiontoallreferencesandsnapallreferencestowalls.
R Createatestrendering.
R Testthefollowingcommandsongeometrycreatedinthefamily:
R Copy/Paste
R Rotate
R Mirror
R VerifythatthefamilypreviewimageisusingthePreviewview.
R Testthefamilyinanactualproject,verifyitsperformance,andensurethattheprojectmatchesthe
designintentofthefamily.
RMCSG66 Version2.1
3.2FAMILYSPECIFICTESTINGGUIDELINES
Dependingonthetypeoffamilybeingtested,theremaybespecificcriteriatotestinadditiontothegeneral
testingthatshouldbeperformedonallfamilies.
Usethistabletodetermineifafamilyrequiresanyspecifictesting:
REVITFAMILYSPECIFICTESTING
FamilyType Example Test
FreelyPlaced Furniture,entourage Testinarelevantprojectcontext.
Forexample,placefurnitureorcaseworkelements
onafloorwithatexturetoensurethatthe
elementsmaskthefloor.
Hosted Window,door Ensurethatthefamilyinteractsproperlywitha
hostandadjuststodifferenthostthicknesses.
FaceBased Lightfixture Ensurethatthefamilyattachesproperlytofaces
anddoesntimproperlyembedin,orprojectaway
from,thefaceoftheobjecttowhichitisattached.
DetailComponent Detailcomponent Ensurethatthefamilysnapstoothergeometry
correctlyandthatitmasksanygeometryonwhich
itisplaced.
Version2.1 RMCSG67