GH_Light Class |
Represents an implementation of a Rhino Light class.
Inheritance HierarchySystemObject
Grasshopper.Kernel.TypesGH_GooLight
Grasshopper.Kernel.TypesGH_GeometricGooLight
Grasshopper.Kernel.TypesGH_Light
Grasshopper.Kernel.TypesGH_GooLight
Grasshopper.Kernel.TypesGH_GeometricGooLight
Grasshopper.Kernel.TypesGH_Light
Namespace: Grasshopper.Kernel.Types
Assembly: Grasshopper (in Grasshopper.dll)
SyntaxThe GH_Light type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GH_Light |
Default constructor, creates an new light
|
| GH_Light(GH_Light) |
Create a duplicate of another GH_Light. This constructor also copies reference data.
|
| GH_Light(Guid) |
Create a new referenced light that references a Rhino light with the specified ID.
|
| GH_Light(Light) |
Create a duplicate of an existing light.
|
Properties| Name | Description | |
|---|---|---|
 | Boundingbox | (Overrides GH_GeometricGooTBoundingbox.) |
| ClippingBox | |
| IsGeometryLoaded |
Gets the load state of this light object. The light is considered to be loaded when the local light instance is not null.
(Overrides GH_GeometricGooTIsGeometryLoaded.) |
| IsReferencedGeometry |
Gets a value indicating whether or not this geometry is referenced.
Not all IGH_GeometricGoo implementations support referenced geometry.
(Inherited from GH_GeometricGooT.) |
| IsValid |
Gets the validity of this light. If the light is referenced but cannot be loaded, then the light is not valid.
(Overrides GH_GeometricGooTIsValid.) |
| IsValidWhyNot |
Gets a string describing the state of "invalidness".
If the instance is valid, then this property should return Nothing or String.Empty.
(Overrides GH_GooTIsValidWhyNot.) |
| ReferenceID | (Overrides GH_GeometricGooTReferenceID.) |
| TypeDescription | (Overrides GH_GooTTypeDescription.) |
| TypeName | (Overrides GH_GooTTypeName.) |
| Value | (Overrides GH_GeometricGooTValue.) |
Methods| Name | Description | |
|---|---|---|
| BakeGeometry | |
| CastFrom |
Remote to Local caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastFrom(Object).) |
| CastToQ(Q) |
Attempt a cast to type T.
(Inherited from GH_GeometricGooT.) |
| CastToQ(Q) |
Attempt a cast to type Q.
(Inherited from GH_GooT.) |
| CastToT(T) |
Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_GeometricGooTCastToQ(Q).) |
| ClearCaches |
Clears all volatile caches for this instance. The boundingbox is cleared, and if the light is referenced,
the local instance of the light is erased.
(Overrides GH_GeometricGooTClearCaches.) |
| DrawViewportMeshes | |
| DrawViewportWires | |
| Duplicate | (Overrides GH_GeometricGooTDuplicate.) |
| DuplicateGeometry |
Create a duplicate of this light.
(Overrides GH_GeometricGooTDuplicateGeometry.) |
| DuplicateLight |
Create a duplicate of this light.
|
| EmitProxy |
Create a new proxy for this instance. Return Null if this class does not support proxies.
(Inherited from GH_GeometricGooT.) |
| GetBoundingBox | (Overrides GH_GeometricGooTGetBoundingBox(Transform).) |
| LoadGeometry |
If the geometry is referenced and currently unloaded, forces loading of the geometry.
Not all IGH_GeometricGoo implementations support referenced geometry.
(Inherited from GH_GeometricGooT.) |
| LoadGeometry(RhinoDoc) |
If the light is referenced and not yet loaded, attempts to load the light.
(Overrides GH_GeometricGooTLoadGeometry(RhinoDoc).) |
| Morph | (Overrides GH_GeometricGooTMorph(SpaceMorph).) |
| Read | (Overrides GH_GooTRead(GH_IReader).) |
| ScriptVariable | (Overrides GH_GooTScriptVariable.) |
| ToString |
Format the dimension using default grasshopper formatting logic.
(Overrides GH_GooTToString.) |
| Transform | (Overrides GH_GeometricGooTTransform(Transform).) |
| Write | (Overrides GH_GooTWrite(GH_IWriter).) |
Fields
See Also