Skip to content

BH.oM.Structure.Elements.RigidLink

A rigid link object defining rigid constraints between two or more nodes.

Class structure

Implemented interfaces and base types

The RigidLink is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
PrimaryNode Node A single node to which SecondaryNodes are constrained. -
SecondaryNodes List<Node> List of nodes which are constrained to the PrimaryNode. -
Constraint LinkConstraint Defines how SecondaryNodes are constrained to the PrimaryNode. The LinkConstraint describes translation and rotation of SecondaryNodes with respect to the PrimaryNode's coordinate system. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
BHoM_Guid Guid - -
Name string - -
Fragments FragmentSet - -
Tags HashSet<string> - -
CustomData Dictionary<string, object> - -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
Geometry IGeometry Gets the geometry of a RigidLink as a list of lines between the primary node and the secondary nodes. Method required for automatic display in UI packages. - Structure_Engine
SplitRigidLink List<RigidLink> Splits a RigidLink into one or more RigidLinks, each of which has exactly one SecondaryNode. - SAP2000_Engine

Code and Schema

C# implementation

C#
public class RigidLink : BH.oM.Base.BHoMObject, BH.oM.Base.IBHoMObject, BH.oM.Base.IObject

Assembly: Structure_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Structure_oM/Elements/RigidLink.json"
}

The JSON Schema is available on github here: