BuilderElementStraightLine Class

Abstract base class of straight linear elements like GrassBeams or GrassTrusses that live in a GH definition

Inheritance Hierarchy

SystemObject
  Karamba.ElementsBuilderElement
    Karamba.ElementsBuilderElementStraightLine
      Karamba.ElementsBuilderBeam

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

Syntax

C++

Copy

[SerializableAttribute]
public abstract class BuilderElementStraightLine : BuilderElement

<SerializableAttribute>
Public MustInherit Class BuilderElementStraightLine
	Inherits BuilderElement

[SerializableAttribute]
public ref class BuilderElementStraightLine abstract : public BuilderElement

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type BuilderElementStraightLine =  
    class
        inherit BuilderElement
    end

The BuilderElementStraightLine type exposes the following members.

Constructors

	Name	Description
	BuilderElementStraightLine	create builder for straight-line elements
	BuilderElementStraightLine(Int32, Int32)	define a straight line element from the indexes of its end-points
	BuilderElementStraightLine(Point3, Point3)	define a straight line element from two end-points

Top

Properties

	Name	Description
	bending_stiff	setter/getter for bending stiffness (turns beams into trusses and vice versa) (Inherited from BuilderElement.)
	canBuckle	returns list of nodal indexes or null (Inherited from BuilderElement.)
	color	user defined color of the beam-set (Inherited from BuilderElement.)
	crosec	return cross section of the element (Inherited from BuilderElement.)
	Ecce	nodal eccentricity of the element (Inherited from BuilderElement.)
	ecce_glo	set/get eccentricity which is defined in the global coordinate system (Inherited from BuilderElement.)
	ecce_loc	sets/gets 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.)
	hasEccent	getter for flag which is true if element eccentricity is present (Inherited from BuilderElement.)
	id	set/get identifier (name) of the element (Inherited from BuilderElement.)
	is_active	set/get activation state of the element. 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	true if the builder element is valid (Overrides BuilderElementis_valid.)
	is_visible	set/get visibility of the element: true if the element is visible on the canvas (Inherited from BuilderElement.)
	IsValid	true if the element is valid (Inherited from BuilderElement.)
	modified_height	set gets 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	set gets 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	returns list of nodal indexes or null (Inherited from BuilderElement.)
	Ori	orientation of the element (Inherited from BuilderElement.)
	parent_ind	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	position of the element (Inherited from BuilderElement.)
	zg	set distance of transverse load from center of shear. Is positive if the load points towards the center of shear.

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. (Overrides BuilderElementaccepts(CroSec).)
	BucklingLength	set buckling length in local direction
	BucklingLength_IsUserValue	return true if buckling length was set by user
	BucklingLength_Set
	BucklingLength_SetEstimate	sets an estimate for the buckling length in local Y-direction
	Clone	clone the builder-element (Inherited from BuilderElement.)
	Clone(ModelElement)	clone grass-element and link it to a given model element. (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
	disassembleElement	Disassemble an element into its constituents (Overrides BuilderElementdisassembleElement(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.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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 (Overrides BuilderElementsnapElement(ListPoint3, NKDTreeDupli, MessageLogger).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	_color	user defined color of the beam-set (Inherited from BuilderElement.)
	_eccentricity	nodal eccentricity of the element (Inherited from BuilderElement.)
	_id	user given identification (name) of element (Inherited from BuilderElement.)
	_orientation	orientation of the element (Inherited from BuilderElement.)
	_position	position of the element (Inherited from BuilderElement.)

Top

Reference

Karamba.Elements Namespace