Component_ModelView Class

GH-component that lets you inspect the current state of the model. Plug it into the data pipeline in front of "Beam View" or "Shell View" to control the overall model display.

Inheritance Hierarchy

SystemObject
  GH_InstanceDescription
    GH_DocumentObject
      GH_ActiveObject
        GH_Component
          Karamba.GHopper.Utilities.UIWidgetsGH_ExtendableComponent
            Karamba.GHopper.ModelsComponent_ModelView

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

Syntax

C++

Copy

public class Component_ModelView : GH_ExtendableComponent

Public Class Component_ModelView
	Inherits GH_ExtendableComponent

public ref class Component_ModelView : public GH_ExtendableComponent

type Component_ModelView =  
    class
        inherit GH_ExtendableComponent
    end

The Component_ModelView type exposes the following members.

Constructors

	Name	Description
	Component_ModelView	Initializes a new instance of the Component_ModelView class

Top

Properties

	Name	Description
	Attributes	(Inherited from GH_DocumentObject.)
	Category	(Inherited from GH_InstanceDescription.)
	ClippingBox	(Overrides GH_Component.ClippingBox.)
	ComponentGuid	(Overrides GH_DocumentObject.ComponentGuid.)
	Description	(Inherited from GH_InstanceDescription.)
	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.)
	SubCategory	(Inherited from GH_InstanceDescription.)

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	(Inherited from GH_Component.)
	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	(Overrides GH_Component.BeforeSolveInstance.)
	ClearData	(Inherited from GH_Component.)
	ClearRuntimeMessages	(Inherited from GH_Component.)
	CollectData	(Inherited from GH_Component.)
	ComputeData	(Inherited from GH_ExtendableComponent.)
	CopyFrom	(Inherited from GH_InstanceDescription.)
	CreateAttributes	(Inherited from GH_ExtendableComponent.)
	DependsOn	(Inherited from GH_Component.)
	DestroyIconCache	(Inherited from GH_DocumentObject.)
	DocumentContextChanged	(Inherited from GH_Component.)
	DrawViewportMeshes	(Inherited from GH_Component.)
	DrawViewportWires	(Inherited from GH_Component.)
	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.)
	GetMenuDescription	(Inherited from GH_ExtendableComponent.)
	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	(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	(Overrides GH_ExtendableComponentOnComponentLoaded.)
	OnComponentReset	gets called when the components output invalidates. (Overrides GH_ExtendableComponentOnComponentReset(GH_ExtendableComponentAttributes).)
	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.)
	OutputConnected	return true if output of given index is connected to other components. (Inherited from GH_ExtendableComponent.)
	OutputInUse	Determine whether any output parameter is visible. (Inherited from GH_ExtendableComponent.)
	OutputInUse(Int32)	Determine whether output parameter at given index is visible. (Inherited from GH_ExtendableComponent.)
	PostConstructor	(Inherited from GH_Component.)
	Read	(Inherited from GH_ExtendableComponent.)
	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.)
	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.)
	setModelProps	Sets the properties of all models according to the properties of the ModelView and expires the solution. Is meant to be called from the GUI-events.
	Setup	setup for the component. (Overrides GH_ExtendableComponentSetup(GH_ExtendableComponentAttributes).)
	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	(Overrides GH_Component.SolveInstance(IGH_DataAccess).)
	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	(Inherited from GH_Component.)
	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
	displayProperties	model display fields.
	m_attributes	(Inherited from GH_DocumentObject.)

Top

Reference

Karamba.GHopper.Models Namespace