Skip to content

Commit

Permalink
Set02| Add Node Documentation for... (#3086)
Browse files Browse the repository at this point in the history
* Add Node Documentation for...

- RevitNodes.Revit.Elements.FamilyType.Name
- RevitNodes.Revit.Elements.FamilyType.Family
- RevitNodes.Revit.Elements.FamilyType.ByFamilyAndName
- RevitNodes.Revit.Elements.FamilyType.ByFamilyNameAndTypeName
- RevitNodes.Revit.Elements.FamilyType.ByName
- RevitNodes.Revit.Elements.FamilyInstance.Location
- RevitNodes.Revit.Elements.FamilyInstance.FacingOrientation
- RevitNodes.Revit.Elements.FamilyInstance.GetHost
- RevitNodes.Revit.Elements.FamilyInstance.GetFamily
- RevitNodes.Revit.Elements.FamilyInstance.SetRotation

* Move to Review Folder

* Update Revit.Elements.FamilyInstance.FacingOrientation.md

* Add id notes

* Update Revit.Elements.FamilyInstance.Location.md

* Comments

* Move nodes to complete.
  • Loading branch information
johnpierson authored Aug 28, 2024
1 parent bceefe7 commit 63b40b7
Show file tree
Hide file tree
Showing 33 changed files with 3,330 additions and 0 deletions.
147 changes: 147 additions & 0 deletions doc/distrib/NodeHelpFiles/Revit.Elements.Family.ByName.dyn
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
{
"Uuid": "ee61484e-5c8a-4d9b-99c8-bd0580895762",
"IsCustomNode": false,
"Description": "",
"Name": "Revit.Elements.Family.ByName",
"ElementResolver": {
"ResolutionMap": {}
},
"Inputs": [],
"Outputs": [],
"Nodes": [
{
"ConcreteType": "Dynamo.Graph.Nodes.ZeroTouch.DSFunction, DynamoCore",
"Id": "00ba6580a0594b159e4f779059007be2",
"NodeType": "FunctionNode",
"Inputs": [
{
"Id": "766d0d1073294890bb932a6c7123bece",
"Name": "name",
"Description": "The name of the family in the current document\n\nstring",
"UsingDefaultValue": false,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
}
],
"Outputs": [
{
"Id": "41c520048fe5488da786efd120e10b62",
"Name": "Family",
"Description": "Family",
"UsingDefaultValue": false,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
}
],
"FunctionSignature": "Revit.Elements.Family.ByName@string",
"Replication": "Auto",
"Description": "Obtain a Family from the current document given it's name\n\nFamily.ByName (name: string): Family"
},
{
"ConcreteType": "CoreNodeModels.Input.StringInput, CoreNodeModels",
"Id": "8c1333ffc1aa464eacedaa90019d94f4",
"NodeType": "StringInputNode",
"Inputs": [],
"Outputs": [
{
"Id": "d9e0fd59c46d4a60a81fcc5eff88ebf4",
"Name": "",
"Description": "String",
"UsingDefaultValue": false,
"Level": 2,
"UseLevels": false,
"KeepListStructure": false
}
],
"Replication": "Disabled",
"Description": "Creates a string",
"InputValue": "Door-Passage-Single-Flush"
}
],
"Connectors": [
{
"Start": "d9e0fd59c46d4a60a81fcc5eff88ebf4",
"End": "766d0d1073294890bb932a6c7123bece",
"Id": "8e89cabeec2840f68efa65bd49843b2b",
"IsHidden": "False"
}
],
"Dependencies": [],
"NodeLibraryDependencies": [],
"EnableLegacyPolyCurveBehavior": null,
"Thumbnail": "",
"GraphDocumentationURL": null,
"ExtensionWorkspaceData": [
{
"ExtensionGuid": "28992e1d-abb9-417f-8b1b-05e053bee670",
"Name": "Properties",
"Version": "3.2",
"Data": {}
},
{
"ExtensionGuid": "DFBD9CC0-DB40-457A-939E-8C8555555A9D",
"Name": "Generative Design",
"Version": "8.1",
"Data": {}
}
],
"Author": "",
"Linting": {
"activeLinter": "None",
"activeLinterId": "7b75fb44-43fd-4631-a878-29f4d5d8399a",
"warningCount": 0,
"errorCount": 0
},
"Bindings": [],
"View": {
"Dynamo": {
"ScaleFactor": 1.0,
"HasRunWithoutCrash": true,
"IsVisibleInDynamoLibrary": true,
"Version": "3.2.1.5366",
"RunType": "Automatic",
"RunPeriod": "1000"
},
"Camera": {
"Name": "_Background Preview",
"EyeX": -17.0,
"EyeY": 24.0,
"EyeZ": 50.0,
"LookX": 12.0,
"LookY": -13.0,
"LookZ": -58.0,
"UpX": 0.0,
"UpY": 1.0,
"UpZ": 0.0
},
"ConnectorPins": [],
"NodeViews": [
{
"Id": "00ba6580a0594b159e4f779059007be2",
"Name": "Family.ByName",
"IsSetAsInput": false,
"IsSetAsOutput": false,
"Excluded": false,
"ShowGeometry": true,
"X": 781.4000000000001,
"Y": 360.8
},
{
"Id": "8c1333ffc1aa464eacedaa90019d94f4",
"Name": "String",
"IsSetAsInput": false,
"IsSetAsOutput": false,
"Excluded": false,
"ShowGeometry": true,
"X": 450.20000000000005,
"Y": 360.8
}
],
"Annotations": [],
"X": 0.0,
"Y": 0.0,
"Zoom": 1.0
}
}
8 changes: 8 additions & 0 deletions doc/distrib/NodeHelpFiles/Revit.Elements.Family.ByName.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## In Depth
`Family.ByName` returns the family definition from the current document (if available). If the family is not available in the current document, a null value is returned.

In the example below, a family definition for "Door-Passage-Single-Flush" is returned, along with its element id (in green).
___
## Example File

![Family.ByName](./Revit.Elements.Family.ByName_img.jpg)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 63b40b7

Please sign in to comment.