Component_MaterialProps Class

GH-component that sets the characteristic parameters of a material.

GH-component that modifies the properties of elements on the fly or creates an element modifier.

Inheritance Hierarchy

SystemObject
  GH_InstanceDescription
    GH_DocumentObject
      GH_ActiveObject
        GH_Component
          Karamba.GHopper.Utilities.UIWidgetsGH_SwitcherComponent
            Karamba.GHopper.MaterialsComponent_MaterialProps

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

Syntax

C++

Copy

public class Component_MaterialProps : GH_SwitcherComponent

Public Class Component_MaterialProps
	Inherits GH_SwitcherComponent

public ref class Component_MaterialProps : public GH_SwitcherComponent

type Component_MaterialProps =  
    class
        inherit GH_SwitcherComponent
    end

The Component_MaterialProps type exposes the following members.

Constructors

	Name	Description
	Component_MaterialProps	Initializes a new instance of the Component_MaterialProps class

Top

Properties

	Name	Description
	ActiveUnit	Get active evaluation unit. (Inherited from GH_SwitcherComponent.)
	Attributes	(Inherited from GH_DocumentObject.)
	Category	(Inherited from GH_InstanceDescription.)
	ClippingBox	(Inherited from GH_Component.)
	ComponentGuid	(Overrides GH_DocumentObject.ComponentGuid.)
	DefaultEvaluationUnit	Set components default/initial evaluation unit. (Overrides GH_SwitcherComponentDefaultEvaluationUnit.)
	Description	(Inherited from GH_InstanceDescription.)
	EvalUnits	Get evaluation units. (Inherited from GH_SwitcherComponent.)
	Exposure	(Overrides GH_DocumentObject.Exposure.)
	HasCategory	(Inherited from GH_InstanceDescription.)
	HasSubCategory	(Inherited from GH_InstanceDescription.)
	HelpDescription	(Inherited from GH_Component.)
	Hidden	(Inherited from GH_Component.)
	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.)
	InConstructor	(Inherited from GH_Component.)
	InstanceDescription	(Inherited from GH_Component.)
	InstanceGuid	(Inherited from GH_InstanceDescription.)
	IsBakeCapable	(Inherited from GH_Component.)
	IsDataProvider	(Inherited from GH_Component.)
	IsPreviewCapable	(Inherited from GH_Component.)
	IsValidPrincipalParameterIndex	(Inherited from GH_Component.)
	Keywords	(Inherited from GH_InstanceDescription.)
	Locked	(Inherited from GH_Component.)
	Message	(Inherited from GH_Component.)
	MutableNickName	(Inherited from GH_ActiveObject.)
	Name	(Inherited from GH_InstanceDescription.)
	NickName	(Inherited from GH_InstanceDescription.)
	Obsolete	(Inherited from GH_DocumentObject.)
	Params	(Inherited from GH_Component.)
	Phase	(Inherited from GH_ActiveObject.)
	PrincipalParameterIndex	(Inherited from GH_Component.)
	ProcessorTime	(Inherited from GH_Component.)
	RunCount	(Inherited from GH_Component.)
	RuntimeMessageLevel	(Inherited from GH_Component.)
	StaticData	Get cached component data. (Inherited from GH_SwitcherComponent.)
	SubCategory	(Inherited from GH_InstanceDescription.)
	UnitlessExistence	Determines whether the switcher can exists without an active evaluation unit. Default is false(exactly one unit must be active at any given time). (Inherited from GH_SwitcherComponent.)
	UnitMenuHeader	Get evaluation unit menu selection header. If this field is null or the empty string, a default header tag will be created. (Inherited from GH_SwitcherComponent.)
	UnitMenuName	Get evaluation unit selection-menu name. (Overrides GH_SwitcherComponentUnitMenuName.)

Top

Methods

	Name	Description
	AddedToDocument	(Inherited from GH_Component.)
	AddRuntimeMessage	(Inherited from GH_ActiveObject.)
	AfterSolveInstance	(Inherited from GH_Component.)
	AppendAdditionalComponentMenuItems	(Overrides GH_Component.AppendAdditionalComponentMenuItems(ToolStripDropDown).)
	AppendAdditionalMenuItems	Add evaluation units to context menu. (Inherited from GH_SwitcherComponent.)
	AppendMenuItems	(Inherited from GH_ActiveObject.)
	AssignInitCodeToInputParameter	(Inherited from GH_Component.)
	BakeGeometry(RhinoDoc, ListGuid)	(Inherited from GH_Component.)
	BakeGeometry(RhinoDoc, ObjectAttributes, ListGuid)	(Inherited from GH_Component.)
	BeforeSolveInstance	executed before solve instance. (Inherited from GH_SwitcherComponent.)
	BeforeSolveInstance(EvaluationUnit)	(Overrides GH_SwitcherComponentBeforeSolveInstance(EvaluationUnit).)
	ClearData	(Inherited from GH_Component.)
	ClearRuntimeMessages	(Inherited from GH_Component.)
	ClearUnit	Clear active evaluation unit. If the component cannot exist without an active evaluation unit, this method does nothing. (Inherited from GH_SwitcherComponent.)
	CollectData	(Inherited from GH_Component.)
	ComputeData	(Inherited from GH_Component.)
	CopyFrom	(Inherited from GH_InstanceDescription.)
	CreateAttributes	Create switcher attributes. (Inherited from GH_SwitcherComponent.)
	DependsOn	(Inherited from GH_Component.)
	DestroyIconCache	(Inherited from GH_DocumentObject.)
	DocumentContextChanged	(Inherited from GH_Component.)
	DrawViewportMeshes	(Inherited from GH_Component.)
	DrawViewportWires(IGH_PreviewArgs)	DrawViewportWires override. Invoke's an extended DrawViewportWires method that contains the active evaluation unit. (Inherited from GH_SwitcherComponent.)
	DrawViewportWires(IGH_PreviewArgs, EvaluationUnit)	(Inherited from GH_SwitcherComponent.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExpireDownStreamObjects	(Inherited from GH_Component.)
	ExpirePreview	(Inherited from GH_DocumentObject.)
	ExpireSolution	(Inherited from GH_ActiveObject.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GenerateDefaultHTML	(Inherited from GH_Component.)
	GenerateParameterHelp	(Inherited from GH_Component.)
	GenerateParameterHelp(IGH_Param)	(Inherited from GH_Component.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnit	Get evaluation unit from name. (Inherited from GH_SwitcherComponent.)
	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	(Inherited from GH_Component.)
	IsolateObject	(Inherited from GH_Component.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Menu_AppendBakeItem	(Inherited from GH_ActiveObject.)
	Menu_AppendEnableItem	(Inherited from GH_ActiveObject.)
	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_AppendPublish	(Inherited from GH_DocumentObject.)
	Menu_AppendRuntimeMessages	(Inherited from GH_ActiveObject.)
	MovedBetweenDocuments	(Inherited from GH_Component.)
	NewInstanceGuid	(Inherited from GH_InstanceDescription.)
	NewInstanceGuid(Guid)	(Inherited from GH_InstanceDescription.)
	OnAttributesChanged	(Inherited from GH_DocumentObject.)
	OnComponentLoaded	OnComponentLoaded is called after Component has been loaded f.eg: when component got deserialized. Override in derived class to initialze data wich is depending on widgets. (Overrides GH_SwitcherComponentOnComponentLoaded.)
	OnComponentReset	OnComponentReset is called when the components output(s) invalidate. This happens, when a "nonoptional" input pulg disconnects or the components values get cleared. (Inherited from GH_SwitcherComponent.)
	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.)
	PostConstructor	(Inherited from GH_SwitcherComponent.)
	Read	Read switcher component data. (Inherited from GH_SwitcherComponent.)
	ReadFull	(Inherited from GH_InstanceDescription.)
	RecordUndoEvent(String)	(Inherited from GH_DocumentObject.)
	RecordUndoEvent(GH_UndoRecord)	(Inherited from GH_DocumentObject.)
	RecordUndoEvent(String, IGH_UndoAction)	(Inherited from GH_DocumentObject.)
	RegisterEvaluationUnits	(Overrides GH_SwitcherComponentRegisterEvaluationUnits(EvaluationUnitManager).)
	RegisterInputParams	(Overrides GH_Component.RegisterInputParams(GH_InputParamManager).)
	RegisterOutputParams	(Overrides GH_Component.RegisterOutputParams(GH_OutputParamManager).)
	RegisterRemoteIDs	(Inherited from GH_Component.)
	RemovedFromDocument	(Inherited from GH_Component.)
	RuntimeMessages	(Inherited from GH_Component.)
	SDKCompliancy	(Inherited from GH_ActiveObject.)
	SetIconOverride	(Inherited from GH_DocumentObject.)
	Setup	Base method for initalizing menus and other attribute depending data. Override in derived class to initialze menus. (Inherited from GH_SwitcherComponent.)
	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.)
	SolveInstance(IGH_DataAccess)	SolveInstance override. Invoke's an extended SolveInstance method that contains the active evaluation unit. (Inherited from GH_SwitcherComponent.)
	SolveInstance(IGH_DataAccess, EvaluationUnit)	Override this method to solve instance of compontent with given active unit. (Overrides GH_SwitcherComponentSolveInstance(IGH_DataAccess, EvaluationUnit).)
	SwitchUnit(String, Boolean, Boolean)	Switch to unit with given name. If no unit with given name exists, nothing happens (old state remains). (Inherited from GH_SwitcherComponent.)
	SwitchUnit(EvaluationUnit, Boolean, Boolean)	Switch to supplied unit. (Inherited from GH_SwitcherComponent.)
	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.)
	Write	Write switcher. (Inherited from GH_SwitcherComponent.)
	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
	activeUnit	Currently active unit. The semantics of this field depends on the UnitlessExistence field. if UnitlessExistence is true, this field can be null. Else this field must hold a reference to a valid evaluation unit. (Inherited from GH_SwitcherComponent.)
	evalUnits	Evaluation unit manager. (Inherited from GH_SwitcherComponent.)
	m_attributes	(Inherited from GH_DocumentObject.)
	staticData	Runtime component data. (Inherited from GH_SwitcherComponent.)

Top

Reference

Karamba.GHopper.Materials Namespace