BuilderElement Class

Represents an element which lives in the a GH definition. GrassElement is the base class of generic containers for element data generated by the GH definition. In Assemble it gets converted to Beams, Springs,...

Definition

Namespace: Karamba.Elements
Assembly: KarambaCommon (in KarambaCommon.dll) Version: 3.0.8.0+eb23a7103f0eca0b6d808121e15fec6899194e15
C#
[SerializableAttribute]
public abstract class BuilderElement : BuilderElementBase, 
	ICloneable, ISerializable, IEquatable<BuilderElement>
Inheritance
Object    CommonObject    BuilderElementBase    BuilderElement
Derived
Implements
ICloneable, IEquatableBuilderElement, ISerializable

Constructors

BuilderElement Initializes a new instance of the BuilderElement class. create an element builder.
BuilderElement(SerializationInfo, StreamingContext) Initializes a new instance of the BuilderElement class. Deserialize BuilderElement.

Properties

bending_stiff Gets or sets a value indicating whether bending stiffness is taken into account (turns beams into trusses and shells into membranes and vice versa).
canBuckle Gets or sets a value indicating whether can buckle.
color Gets or sets user defined color of the beam-set.
crosec Gets or sets the return cross section of the element.
Ecce Gets the nodal eccentricity of the element.
ecce_glo Gets or sets eccentricity which is defined in the global coordinate system.
ecce_loc Gets or sets eccentricity which is local to the element and can be separately set for each of them. The other types of eccentricity would be either attached to a cross section or oriented globally.
guid Gets the the builder's identifier.
hasEccent Gets a value indicating whether an element eccentricity is present.
id Gets or sets the identifier (name) of the element.
ids_secondary Gets the secondary identifiers of the element.
is_active Gets or sets a value indicating whether the element is active. If not active, the elements stiffness is reduced to such a degree that it does not influence results any more (soft-kill approach). The small remaining stiffness should however suffice to keep the system from becoming numerically kinematic.
is_valid Gets a value indicating whether the builder element is valid.
is_visible Gets or sets a value indicating whether the element is visible: true if the element is visible on the canvas.
IsValid Gets a value indicating whether the element is valid.
modified_height Gets or sets the cross section height (depth) modification factor of the this element. Can be set in a GH definition with the ModifyBeam-component.
modified_thick Gets or sets the cross section wall thickness modification factor of the this element. Can be set in a GH definition with the ModifyBeam-component.
nII Gets or sets list of nodal indexes or null.
Ori Gets or sets the orientation of the element.
parent_ind Gets or sets index of parent element from which this element may inherit its properties (material, cross section,...) A negative value signals that there is no parent;.
Pos Gets or sets the position of the element.
UserData Gets access to the user-data dictionary.
(Inherited from CommonObject)
visibleSubelementIds Gets or sets the indexes of visible sub-elements.

Methods

accepts Returns true if the given cross section can be applied to the element. Returns false if you test e.g. a shell cross section against a beam element.
addSecondaryID Adds a secondary element identifier.
Clone clone the builder-element.
Clone(ModelElement) clone grass-element and link it to a given model element.
CloneSecondaryIDs clone the secondary element identifiers.
Copy copy contents of another grass-element.
DecomposeElemId decomposes an element identifier into its parts. Multiple id-s may be given via 'ampersand \"id1\"|\"id2\"|\"id3\"' or 'ampersand id1|id2|id3'.
disassembleElement Disassemble an element into its constituents.
Equals(BuilderElement) True if item is equal to this.
Equals(Object) Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object))
Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Overrides ObjectGetHashCode)
GetObjectData Serializes an element.
(Overrides CommonObjectGetObjectData(SerializationInfo, StreamingContext))
GetType Gets the Type of the current instance.
(Inherited from Object)
HasUserData Checks whether the object has user-data attached.
(Inherited from CommonObject)
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
parent_inds return the indexes of all parents of the element.
snapElement change the element if nodes snap together according to the given list of node indexes. returns true if the element was completely snapped.
ToString Returns a string that represents the current object.
(Inherited from CommonObject)

Fields

_color user defined color of the beam-set.
_eccentricity nodal eccentricity of the element.
_guid the builder's identifier.
_id user given primary identification (name) of element.
_ids_secondary user given further identification (name) of element.
_orientation orientation of the element.
_position position of the element.

Extension Methods

ContainerType test if object is (a container like) a list or an array.
(Defined by MiniUtil)

See Also