BuilderBeam Class

Represents a beam or truss element which lives in the a GH definition.

Inheritance Hierarchy

SystemObject
  KarambaCommon.UtilitiesCommonObject
    Karamba.ElementsBuilderElementBase
      Karamba.ElementsBuilderElement
        Karamba.ElementsBuilderElementStraightLine
          Karamba.ElementsBuilderBeam
            Karamba.ElementsModifierBeam

Namespace: Karamba.Elements
Assembly: KarambaCommon (in KarambaCommon.dll) Version: 2.2.0.4 (2.2.0.4)

Syntax

C++

Copy

[SerializableAttribute]
public class BuilderBeam : BuilderElementStraightLine, 
	ISerializable

<SerializableAttribute>
Public Class BuilderBeam
	Inherits BuilderElementStraightLine
	Implements ISerializable

[SerializableAttribute]
public ref class BuilderBeam : public BuilderElementStraightLine, 
	ISerializable

[<SerializableAttribute>]
type BuilderBeam =  
    class
        inherit BuilderElementStraightLine
        interface ISerializable
    end

The BuilderBeam type exposes the following members.

Constructors

	Name	Description
	BuilderBeam	Initializes a new instance of the BuilderBeam class. create an empty beam builder.
	BuilderBeam(Int32, Int32)	Initializes a new instance of the BuilderBeam class. Create a beam-builder from two node indexes.
	BuilderBeam(SerializationInfo, StreamingContext)	Initializes a new instance of the BuilderBeam class. Deserialize BuilderBeam.
	BuilderBeam(Point3, Point3)	Initializes a new instance of the BuilderBeam class. Create a beam-builder from two node positions.

Top

Properties

	Name	Description
	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). (Inherited from BuilderElement.)
	canBuckle	Gets or sets a value indicating whether can buckle. (Inherited from BuilderElement.)
	color	Gets or sets user defined color of the beam-set. (Inherited from BuilderElement.)
	crosec	Gets or sets the return cross section of the element. (Overrides BuilderElementcrosec.)
	Ecce	Gets the nodal eccentricity of the element. (Inherited from BuilderElement.)
	ecce_glo	Gets or sets eccentricity which is defined in the global coordinate system. (Inherited from BuilderElement.)
	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. (Inherited from BuilderElement.)
	guid	Gets the the builder's identifier. (Inherited from BuilderElement.)
	hasEccent	Gets a value indicating whether an element eccentricity is present. (Inherited from BuilderElement.)
	id	Gets or sets the identifier (name) of the element. (Inherited from BuilderElement.)
	ids_secondary	Gets the secondary identifiers of the element. (Inherited from BuilderElement.)
	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. (Inherited from BuilderElement.)
	is_valid	Gets a value indicating whether the builder element is valid. (Inherited from BuilderElementStraightLine.)
	is_visible	Gets or sets a value indicating whether the element is visible: true if the element is visible on the canvas. (Inherited from BuilderElement.)
	IsValid	Gets a value indicating whether the element is valid. (Inherited from BuilderElement.)
	lg	Gets or sets the distance of transverse load from center of shear. Is positive if the load points towards the center of shear. (Inherited from BuilderElementStraightLine.)
	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. (Inherited from BuilderElement.)
	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. (Inherited from BuilderElement.)
	nII	Gets or sets list of nodal indexes or null. (Inherited from BuilderElement.)
	Ori	Gets or sets the orientation of the element. (Inherited from BuilderElement.)
	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;. (Inherited from BuilderElement.)
	Pos	Gets or sets the position of the element. (Inherited from BuilderElement.)
	UserData	Gets access to the user-data dictionary. (Inherited from CommonObject.)

Top

Methods

	Name	Description
	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. (Inherited from BuilderElementStraightLine.)
	addSecondaryID	Adds a secondary element identifier. (Inherited from BuilderElement.)
	BucklingLength	set buckling length in local direction. (Inherited from BuilderElementStraightLine.)
	BucklingLength_IsUserValue	Returns true if buckling length was set by user. (Inherited from BuilderElementStraightLine.)
	BucklingLength_Set	Sets the buckling length of the element. (Inherited from BuilderElementStraightLine.)
	BucklingLength_SetEstimate(Vector3)	sets an estimate for the buckling length in local Y-direction. (Inherited from BuilderElementStraightLine.)
	BucklingLength_SetEstimate(BuilderElementStraightLineBucklingDir, Double)	Sets an estimate for the buckling length in local Y-direction. (Inherited from BuilderElementStraightLine.)
	Clone	clone the builder-element. (Overrides BuilderElementClone.)
	Clone(ModelElement)	clone grass-element and link it to a given model element. (Inherited from BuilderElement.)
	CloneBucklingLength	clones the list of buckling length. (Inherited from BuilderElementStraightLine.)
	CloneSecondaryIDs	clone the secondary element identifiers. (Inherited from BuilderElement.)
	Copy(BuilderElement)	copy contents of another grass-element. (Inherited from BuilderElement.)
	Copy(BuilderElementStraightLine)	fill object with data from another straight line element. (Inherited from BuilderElementStraightLine.)
	disassembleElement	Disassemble an element into its constituents. (Overrides BuilderElementStraightLinedisassembleElement(IReadOnlyListPoint3, Line3, CroSec, ListDouble, FemMaterial, Vector3, Vector3, Plane3, NullableVector3, NullableVector3, NullableVector3, Double, Double, Double, Double, Double, NullableVector3, MessageLogger).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from 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. (Inherited from Object.)
	GetObjectData	Serializes a beam. (Overrides BuilderElementStraightLineGetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasUserData	true if 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. (Inherited from BuilderElement.)
	snapElement	change the element if nodes snap together according to the given list of node indexes. returns true if the element was completely snapped. (Inherited from BuilderElementStraightLine.)
	ToString	Returns a string that represents the current object. (Overrides CommonObjectToString.)

Top

Fields

	Name	Description
	_color	user defined color of the beam-set. (Inherited from BuilderElement.)
	_eccentricity	nodal eccentricity of the element. (Inherited from BuilderElement.)
	_guid	the builder's identifier. (Inherited from BuilderElement.)
	_id	user given primary identification (name) of element. (Inherited from BuilderElement.)
	_ids_secondary	user given further identification (name) of element. (Inherited from BuilderElement.)
	_orientation	orientation of the element. (Inherited from BuilderElement.)
	_position	position of the element. (Inherited from BuilderElement.)
	crosec_	the elements cross section.
	joint	joint definition applied to the beams endpoints. (Inherited from BuilderElementStraightLine.)

Top

Reference

Karamba.Elements Namespace