pyRevit Challenge - Day 16 (Crash-n-Clash)

PLAN

🫳Revit Is Nothing Without Shared Parameters

I'm sure you already tried running your custom tools and fail because not all projects have your Shared parameters by default…

Or maybe you started a brand new project and it misses too many shared parameters… And importing them manually is such a waste of time.

So, the Goal for Today:

Create a tool that can batch import shared parameters.

We'll ask user what shared paramters to load, then a few additional settings like:

Instance or Type
Categories
Parameter Group
Varies by Group

And with that we can import all of them at once saving a lot of time and nerves to our users.

So let's begin Smuggling Shared Parameters.

RESEARCH

Coding CheatSheet

Here's everything you might need for today's challenge.

Coding Blocks

Read Loaded Parameters

Set SharedParameterFile

Find SharedParamtere in File

Get All Categories

Ask User For Categories

Workaround: Set VariesByGroup

Access SharedParameterFile

Read SharedParameterFile

Get Category

Create Category Set

Add Shared Parameter (Instance)

Select Parameter Group

Read Loaded Parameters

Access SharedParameterFile

Set SharedParameterFile

Read SharedParameterFile

Find SharedParamtere in File

Get Category

Get All Categories

Create Category Set

Ask User For Categories

Add Shared Parameter (Instance)

Workaround: Set VariesByGroup

Select Parameter Group

Notes

Revit API Docs

Application.OpenSharedParameterFile Method
DefinitionFile Class
Document.ParameterBindings property
BindingMap Class
BindingMap.Insert Method (RVT 24+)
BindingMap.Insert Method (RVT 23-)
ExternalDefinition Class
CategorySet Class
InstanceBinding Constructor
TypeBinding Constructor
GroupTypeId Class (RVT 24+)
Category.GetCategory Method
Category.AllowsBoundParameters Property

pyRevit Dev Docs

pyRevit - Efffective Input

EF-Notes:

🔸Shared Parameter File

Sometimes Revit app doesn't have open SharedParameterFile. If that happens either notify user to set it manually, or you can hardcode your office standard one.

🔸Override SharedParameters

Note that you can't import parameters already in the project. It won't update their settings, so instead you'll need to get definitions and modify it differently. Refer to docs.

🔸Forward Iterator of BindingsMap

If you want to read loaded parameters then you need ParameterBindings map. And you can't read it like a normal list, instead you have to get ForwardIterator where you have to get one item at the time inside while loop to read it. Don't over complicate it. Just copy my code and use it as it is…

🔸API Change for BindingMap Insert

There's minor change in how to select Parameter Group when inserting new Shared Parameters. Nothing complicated, just need to remember to use different code before and after Revit 2024.

RESEARCH

Coding CheatSheet

Here's everything you might need for today's challenge.

Coding Blocks

Read Loaded Parameters

Access SharedParameterFile

Set SharedParameterFile

Read SharedParameterFile

Find SharedParamtere in File

Get Category

Get All Categories

Create Category Set

Ask User For Categories

Add Shared Parameter (Instance)

Workaround: Set VariesByGroup

Select Parameter Group

Notes

Revit API Docs

Application.OpenSharedParameterFile Method
DefinitionFile Class
Document.ParameterBindings property
BindingMap Class
BindingMap.Insert Method (RVT 24+)
BindingMap.Insert Method (RVT 23-)
ExternalDefinition Class
CategorySet Class
InstanceBinding Constructor
TypeBinding Constructor
GroupTypeId Class (RVT 24+)
Category.GetCategory Method
Category.AllowsBoundParameters Property

pyRevit Dev Docs

pyRevit - Efffective Input

EF-Notes:

🔸Shared Parameter File

Sometimes Revit app doesn't have open SharedParameterFile. If that happens either notify user to set it manually, or you can hardcode your office standard one.

🔸Override SharedParameters

Note that you can't import parameters already in the project. It won't update their settings, so instead you'll need to get definitions and modify it differently. Refer to docs.

🔸Forward Iterator of BindingsMap

🔸API Change for BindingMap Insert

There's minor change in how to select Parameter Group when inserting new Shared Parameters. Nothing complicated, just need to remember to use different code before and after Revit 2024.

OUTLINE

Step-by-Step Plan

Break down logic of the tool idea into smaller chunks so it's easier to brainstorm, find hidden steps and code.

Read Shared
Parameter File

Import
Shared Parameters

Check Loaded
Parameters

Ask User To Select
Param To Import

Ask Settings: Type/Instance
Categories / Param.Group

OUTLINE

Step-by-Step Plan

Break down logic of the tool idea into smaller chunks so it's easier to brainstorm, find hidden steps and code.

Read Shared
Parameter File

Import
Shared Parameters

Check Loaded
Parameters

Ask User To Select
Param To Import

Ask Settings: Type/Instance
Categories / Param.Group

NB!

TRY BUILDING
THIS TOOL YOURSELF
DON'T RUSH TO SOLUTION

Unless… You're a Beginner

According to GENERATION EFFECT

The Harder You Work, The Deeper It'll be Wired in Your Brain

NB!

TRY BUILDING
THIS TOOL YOURSELF
DON'T RUSH TO SOLUTION

Unless… You're a Beginner

According to GENERATION EFFECT

The Harder You Work, The Deeper
It'll be Wired in Your Brain

CODE

Code Quick-n-Dirty.

The Goal is to create a proof of concept. Don't try to make it perfect. Skip steps if necessary. Keep it ugly. Keep it slow. JUST. MAKE. IT. WORK…

Proof Of Concept

SCRIPT: PROOF OF CONCEPT

CODE

Code Quick-n-Dirty

The Goal is to create a proof of concept. Don't try to make it perfect. Skip steps if necessary. Keep it ugly. Keep it slow. JUST. MAKE. IT. WORK…