Param_Element Class

Part of the Grasshopper wrapper for elements (beams, trusses, shells,...) of the statical model.

Inheritance Hierarchy

SystemObject
  GH_InstanceDescription
    GH_DocumentObject
      GH_ActiveObject
        GH_ParamGH_Element
          GH_PersistentParamGH_Element
            Karamba.GHopper.ElementsParam_Element

Namespace: Karamba.GHopper.Elements
Assembly: Karamba3D (in Karamba3D.dll) Version: 2.2.0.5 (2.2.0.5)

Syntax

C++

Copy

public class Param_Element : GH_PersistentParam<GH_Element>

Public Class Param_Element
	Inherits GH_PersistentParam(Of GH_Element)

public ref class Param_Element : public GH_PersistentParam<GH_Element^>

type Param_Element =  
    class
        inherit GH_PersistentParam<GH_Element>
    end

The Param_Element type exposes the following members.

Constructors

	Name	Description
	Param_Element	Initializes a new instance of the Param_Element class

Top

Properties

	Name	Description
	Access	(Inherited from GH_ParamGH_Element.)
	Attributes	(Inherited from GH_DocumentObject.)
	Category	(Inherited from GH_InstanceDescription.)
	ComponentGuid	(Overrides GH_DocumentObject.ComponentGuid.)
	DataMapping	(Inherited from GH_ParamGH_Element.)
	DataType	(Inherited from GH_PersistentParamGH_Element.)
	Description	(Inherited from GH_InstanceDescription.)
	Exposure	(Overrides GH_DocumentObject.Exposure.)
	HasCategory	(Inherited from GH_InstanceDescription.)
	HasProxySources	(Inherited from GH_ParamGH_Element.)
	HasSubCategory	(Inherited from GH_InstanceDescription.)
	Icon	(Overrides GH_DocumentObject.Icon.)
	Icon_24x24	(Inherited from GH_DocumentObject.)
	Icon_24x24_Locked	(Inherited from GH_DocumentObject.)
	IconCapableUI	(Inherited from GH_ActiveObject.)
	IconDisplayMode	(Inherited from GH_DocumentObject.)
	InstanceDescription	(Inherited from GH_ParamGH_Element.)
	InstanceGuid	(Inherited from GH_InstanceDescription.)
	IsDataProvider	(Inherited from GH_ParamGH_Element.)
	IsPrincipal	(Inherited from GH_ParamGH_Element.)
	Keywords	(Inherited from GH_InstanceDescription.)
	Kind	(Inherited from GH_ParamGH_Element.)
	Locked	(Inherited from GH_ActiveObject.)
	MutableNickName	(Inherited from GH_ActiveObject.)
	Name	(Inherited from GH_InstanceDescription.)
	NickName	(Inherited from GH_InstanceDescription.)
	Obsolete	(Inherited from GH_DocumentObject.)
	Optional	(Inherited from GH_ParamGH_Element.)
	PersistentData	(Inherited from GH_PersistentParamGH_Element.)
	PersistentDataCount	(Inherited from GH_PersistentParamGH_Element.)
	Phase	(Inherited from GH_ActiveObject.)
	ProcessorTime	(Inherited from GH_ParamGH_Element.)
	ProxySourceCount	(Inherited from GH_ParamGH_Element.)
	Recipients	(Inherited from GH_ParamGH_Element.)
	Reverse	(Inherited from GH_ParamGH_Element.)
	RuntimeMessageLevel	(Inherited from GH_ActiveObject.)
	Simplify	(Inherited from GH_ParamGH_Element.)
	SourceCount	(Inherited from GH_ParamGH_Element.)
	Sources	(Inherited from GH_ParamGH_Element.)
	StateTags	(Inherited from GH_ParamGH_Element.)
	SubCategory	(Inherited from GH_InstanceDescription.)
	Type	(Inherited from GH_ParamGH_Element.)
	TypeName	(Inherited from GH_ParamGH_Element.)
	VolatileData	(Inherited from GH_ParamGH_Element.)
	VolatileDataCount	(Inherited from GH_ParamGH_Element.)
	WireDisplay	(Inherited from GH_ParamGH_Element.)

Top

Methods

	Name	Description
	AddedToDocument	(Inherited from GH_DocumentObject.)
	AddRuntimeMessage	(Inherited from GH_ActiveObject.)
	AddSource(IGH_Param)	(Inherited from GH_ParamGH_Element.)
	AddSource(IGH_Param, Int32)	(Inherited from GH_ParamGH_Element.)
	AddVolatileData(GH_Path, Int32, Object)	(Inherited from GH_ParamGH_Element.)
	AddVolatileData(GH_Path, Int32, UTP)	(Inherited from GH_ParamGH_Element.)
	AddVolatileDataList(GH_Path, IEnumerable)	(Inherited from GH_ParamGH_Element.)
	AddVolatileDataList(GH_Path, ListUTP)	(Inherited from GH_ParamGH_Element.)
	AddVolatileDataTree(IGH_Structure)	(Inherited from GH_ParamGH_Element.)
	AddVolatileDataTree(GH_StructureUTP)	(Inherited from GH_ParamGH_Element.)
	AppendAdditionalMenuItems	(Inherited from GH_PersistentParamGH_Element.)
	AppendMenuItems	(Inherited from GH_ActiveObject.)
	Cast_Object	(Inherited from GH_ParamGH_Element.)
	ClearData	(Inherited from GH_ParamGH_Element.)
	ClearProxySources	(Inherited from GH_ParamGH_Element.)
	ClearRuntimeMessages	(Inherited from GH_ActiveObject.)
	CollectData	(Inherited from GH_ParamGH_Element.)
	CollectVolatileData_Custom	(Inherited from GH_PersistentParamGH_Element.)
	CollectVolatileData_FromSources	(Inherited from GH_ParamGH_Element.)
	ComputeData	(Inherited from GH_ParamGH_Element.)
	ConversionCallback	(Inherited from GH_ParamGH_Element.)
	CopyFrom	(Inherited from GH_InstanceDescription.)
	CreateAttributes	(Inherited from GH_ParamGH_Element.)
	CreateProxySources	(Inherited from GH_ParamGH_Element.)
	DependsOn	(Inherited from GH_ParamGH_Element.)
	DestroyIconCache	(Inherited from GH_DocumentObject.)
	DocumentContextChanged	(Inherited from GH_DocumentObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExpireDownStreamObjects	(Inherited from GH_ParamGH_Element.)
	ExpirePreview	(Inherited from GH_DocumentObject.)
	ExpireSolution	(Inherited from GH_ActiveObject.)
	ExpireSolutionTopLevel	(Inherited from GH_ParamGH_Element.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Format	(Inherited from GH_ParamGH_Element.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue(String, Boolean)	(Inherited from GH_DocumentObject.)
	GetValue(String, Int32)	(Inherited from GH_DocumentObject.)
	GetValue(String, Double)	(Inherited from GH_DocumentObject.)
	GetValue(String, String)	(Inherited from GH_DocumentObject.)
	GetValue(String, Color)	(Inherited from GH_DocumentObject.)
	HtmlHelp_Source	(Overrides GH_DocumentObject.HtmlHelp_Source.)
	InstantiateT	(Overrides GH_Param.InstantiateT.)
	IsolateObject	(Inherited from GH_ParamGH_Element.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Menu_AppendBakeItem	(Inherited from GH_ActiveObject.)
	Menu_AppendDestroyPersistent	(Inherited from GH_PersistentParamGH_Element.)
	Menu_AppendDisconnectWires	(Inherited from GH_ParamGH_Element.)
	Menu_AppendEnableItem	(Inherited from GH_ActiveObject.)
	Menu_AppendExtractParameter	(Inherited from GH_PersistentParamGH_Element.)
	Menu_AppendFlattenParameter	(Inherited from GH_ParamGH_Element.)
	Menu_AppendGraftParameter	(Inherited from GH_ParamGH_Element.)
	Menu_AppendInternaliseData	(Inherited from GH_PersistentParamGH_Element.)
	Menu_AppendManageCollection	(Inherited from GH_PersistentParamGH_Element.)
	Menu_AppendObjectHelp	(Inherited from GH_DocumentObject.)
	Menu_AppendObjectName	(Inherited from GH_DocumentObject.)
	Menu_AppendObjectNameEx	(Inherited from GH_DocumentObject.)
	Menu_AppendPreviewItem	(Inherited from GH_ActiveObject.)
	Menu_AppendPrincipalParameter	(Inherited from GH_ParamGH_Element.)
	Menu_AppendPromptMore	(Inherited from GH_PersistentParamGH_Element.)
	Menu_AppendPromptOne	(Inherited from GH_PersistentParamGH_Element.)
	Menu_AppendPublish	(Inherited from GH_DocumentObject.)
	Menu_AppendReverseParameter	(Inherited from GH_ParamGH_Element.)
	Menu_AppendRuntimeMessages	(Inherited from GH_ActiveObject.)
	Menu_AppendSimplifyParameter	(Inherited from GH_ParamGH_Element.)
	Menu_AppendWireDisplay	(Inherited from GH_ParamGH_Element.)
	Menu_CreateMultilineTextEditItem	(Inherited from GH_PersistentParamGH_Element.)
	Menu_CustomMultiValueItem	(Inherited from GH_PersistentParamGH_Element.)
	Menu_CustomSingleValueItem	(Inherited from GH_PersistentParamGH_Element.)
	MovedBetweenDocuments	(Inherited from GH_DocumentObject.)
	NewInstanceGuid	(Inherited from GH_InstanceDescription.)
	NewInstanceGuid(Guid)	(Inherited from GH_InstanceDescription.)
	OnAttributesChanged	(Inherited from GH_DocumentObject.)
	OnDisplayExpired	(Inherited from GH_DocumentObject.)
	OnObjectChanged(GH_ObjectEventType)	(Inherited from GH_DocumentObject.)
	OnObjectChanged(String)	(Inherited from GH_DocumentObject.)
	OnObjectChanged(GH_ObjectChangedEventArgs)	(Inherited from GH_DocumentObject.)
	OnObjectChanged(GH_ObjectEventType, Object)	(Inherited from GH_DocumentObject.)
	OnObjectChanged(String, Object)	(Inherited from GH_DocumentObject.)
	OnPingDocument	(Inherited from GH_DocumentObject.)
	OnPreviewExpired	(Inherited from GH_DocumentObject.)
	OnSolutionExpired	(Inherited from GH_DocumentObject.)
	OnVolatileDataCollected	(Inherited from GH_ParamGH_Element.)
	PreferredCast	(Overrides GH_Param.PreferredCast(Object).)
	PrepareForPrompt	(Inherited from GH_PersistentParamGH_Element.)
	Preview_ComputeClippingBox	(Inherited from GH_ParamGH_Element.)
	Preview_DrawMeshes	(Inherited from GH_ParamGH_Element.)
	Preview_DrawWires	(Inherited from GH_ParamGH_Element.)
	Prompt_ManageCollection	(Inherited from GH_PersistentParamGH_Element.)
	Prompt_Plural	(Overrides GH_PersistentParam.Prompt_Plural(ListUTP).)
	Prompt_Singular	(Overrides GH_PersistentParam.Prompt_Singular(UTP).)
	Read	(Inherited from GH_PersistentParamGH_Element.)
	ReadFull	(Inherited from GH_InstanceDescription.)
	RecordPersistentDataEvent	(Inherited from GH_PersistentParamGH_Element.)
	RecordUndoEvent(String)	(Inherited from GH_DocumentObject.)
	RecordUndoEvent(GH_UndoRecord)	(Inherited from GH_DocumentObject.)
	RecordUndoEvent(String, IGH_UndoAction)	(Inherited from GH_DocumentObject.)
	RecoverFromPrompt	(Inherited from GH_PersistentParamGH_Element.)
	RegisterRemoteIDs	(Inherited from GH_ActiveObject.)
	RegisterRemoteIDsUtil	(Inherited from GH_ParamGH_Element.)
	RelinkProxySources	(Inherited from GH_ParamGH_Element.)
	RemoveAllSources	(Inherited from GH_ParamGH_Element.)
	RemovedFromDocument	(Inherited from GH_DocumentObject.)
	RemoveEffects	(Inherited from GH_ParamGH_Element.)
	RemoveSource(IGH_Param)	(Inherited from GH_ParamGH_Element.)
	RemoveSource(Guid)	(Inherited from GH_ParamGH_Element.)
	Render_AppendGeometry	Obsolete. (Inherited from GH_ParamGH_Element.)
	ReplaceSource(IGH_Param, IGH_Param)	(Inherited from GH_ParamGH_Element.)
	ReplaceSource(Guid, IGH_Param)	(Inherited from GH_ParamGH_Element.)
	RuntimeMessages	(Inherited from GH_ActiveObject.)
	SDKCompliancy	(Inherited from GH_ActiveObject.)
	SetIconOverride	(Inherited from GH_DocumentObject.)
	SetPersistentData(Object)	(Inherited from GH_PersistentParamGH_Element.)
	SetPersistentData(UTP)	(Inherited from GH_PersistentParamGH_Element.)
	SetPersistentData(IEnumerableUTP)	(Inherited from GH_PersistentParamGH_Element.)
	SetPersistentData(GH_StructureUTP)	(Inherited from GH_PersistentParamGH_Element.)
	SetPrincipal	(Inherited from GH_ParamGH_Element.)
	SetValue(String, Boolean)	(Inherited from GH_DocumentObject.)
	SetValue(String, Int32)	(Inherited from GH_DocumentObject.)
	SetValue(String, Double)	(Inherited from GH_DocumentObject.)
	SetValue(String, String)	(Inherited from GH_DocumentObject.)
	SetValue(String, Color)	(Inherited from GH_DocumentObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TriggerAutoSave	(Inherited from GH_DocumentObject.)
	TriggerAutoSave(GH_AutoSaveTrigger)	(Inherited from GH_DocumentObject.)
	TriggerAutoSave(Guid)	(Inherited from GH_DocumentObject.)
	TriggerAutoSave(GH_AutoSaveTrigger, Guid)	(Inherited from GH_DocumentObject.)
	ValuesChanged	(Inherited from GH_DocumentObject.)
	VolatileDataDescription	(Inherited from GH_ParamGH_Element.)
	Write	(Inherited from GH_PersistentParamGH_Element.)
	WriteFull	(Inherited from GH_InstanceDescription.)

Top

Events

	Name	Description
	AttributesChanged	(Inherited from GH_DocumentObject.)
	DisplayExpired	(Inherited from GH_DocumentObject.)
	ObjectChanged	(Inherited from GH_DocumentObject.)
	PingDocument	(Inherited from GH_DocumentObject.)
	PreviewExpired	(Inherited from GH_DocumentObject.)
	SolutionExpired	(Inherited from GH_DocumentObject.)

Top

Fields

	Name	Description
	edge
	m_attributes	(Inherited from GH_DocumentObject.)
	m_data	(Inherited from GH_ParamGH_Element.)

Top

Reference

Karamba.GHopper.Elements Namespace