T_Rhino_Geometry_Light - mcneel/rhinocommon-api-docs GitHub Wiki
Represents a light that shines in the modeling space.
System.Object
Rhino.Runtime.CommonObject
Rhino.Geometry.GeometryBase
Rhino.Geometry.Light
Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0
C#
[SerializableAttribute]
public class Light : GeometryBaseVB
<SerializableAttribute>
Public Class Light
Inherits GeometryBaseThe Light type exposes the following members.
| Name | Description | |
|---|---|---|
 |
Light() | Initializes a new light. |
 |
Light(SerializationInfo, StreamingContext) | Protected constructor used in serialization. |
| Name | Description | |
|---|---|---|
 |
Ambient | Gets or sets the ambient color. |
|
AttenuationVector | Gets or Sets the attenuation vector. |
|
CoordinateSystem | Gets a value, determined by LightStyle, that explains whether the camera directions are relative to World or Camera spaces. |
|
Diffuse | Gets or sets the diffuse color. |
|
Direction | Gets or sets the vector direction of the camera. |
|
HasBrepForm | Returns true if the Brep.TryConvertBrep function will be successful for this object (Inherited from GeometryBase.) |
|
HasUserData | Gets true if this class has any custom information attached to it through UserData. (Inherited from CommonObject.) |
|
HotSpot | The hot spot setting runs from 0.0 to 1.0 and is used to provides a linear interface for controling the focus or concentration of a spotlight. A hot spot setting of 0.0 corresponds to a spot exponent of 128. A hot spot setting of 1.0 corresponds to a spot exponent of 0.0. |
|
Id | Gets the ID of this light. |
|
Intensity | Gets or sets the light intensity. |
|
IsDeformable | true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling. (Inherited from GeometryBase.) |
|
IsDirectionalLight | Gets a value indicating whether the light style is LightStyle CameraDirectional or WorldDirectional. |
|
IsDocumentControlled | If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException. (Inherited from GeometryBase.) |
|
IsEnabled | Gets or sets a value that defines if the light is turned on (true) or off (false). |
|
IsLinearLight | Gets a value indicating whether the light style is LightStyle WorldLinear. |
|
IsPointLight | Gets a value indicating whether the light style is LightStyle CameraPoint or WorldPoint. |
|
IsRectangularLight | Gets a value indicating whether the light style is LightStyle WorldRectangular. |
|
IsSpotLight | Gets a value indicating whether the light style is LightStyle CameraSpot or WorldSpot. |
|
IsSunLight | Gets a value indicating whether this object is a Sun light. |
|
IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) |
|
Length | Gets or sets the height in linear and rectangular lights. (ignored for non-linear/rectangular lights.) |
|
LightStyle | Gets or sets a light style on this camera. |
|
Location | Gets or sets the light or 3D position or location. |
|
Name | Gets or sets the spot light name. |
|
ObjectType | Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. (Inherited from GeometryBase.) |
|
PerpendicularDirection | Gets a perpendicular vector to the camera direction. |
|
PowerCandela | Gets or sets the light power in candelas (cd). |
|
PowerLumens | Gets or sets the light power in lumens (lm). |
|
PowerWatts | Gets or sets the light power in watts (W). |
|
Specular | Gets or sets the specular color. |
|
SpotAngleRadians |
Gets or sets the spot angle in radians.
Ignored for non-spot lights.
angle = 0 to pi/2 (0 to 90 degrees). |
|
SpotExponent | The spot exponent varies from 0.0 to 128.0 and provides an exponential interface for controling the focus or concentration of a spotlight (like the OpenGL GL_SPOT_EXPONENT parameter). The spot exponent and hot spot parameters are linked; changing one will change the other. A hot spot setting of 0.0 corresponds to a spot exponent of 128. A hot spot setting of 1.0 corresponds to a spot exponent of 0.0. |
|
SpotLightShadowIntensity | Gets or sets the spot light shadow intensity. (ignored for non-spot lights.) |
|
UserData | List of custom information that is attached to this class. (Inherited from CommonObject.) |
|
UserDictionary | Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information. (Inherited from CommonObject.) |
|
UserStringCount | Gets the amount of user strings. (Inherited from GeometryBase.) |
|
Width | Gets or sets the width in linear and rectangular lights. (ignored for non-linear/rectangular lights.) |
| Name | Description | |
|---|---|---|
|
ComponentIndex | If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index. (Inherited from GeometryBase.) |
|
ConstructConstObject | Assigns a parent object and a subobject index to this. (Inherited from CommonObject.) |
|
CreateSunLight(Sun) | Constructs a light which simulates a Sun. |
|
|
CreateSunLight(Double, Double, Double) | Constructs a light that represents the Sun. |
|
|
CreateSunLight(Double, DateTime, Double, Double) | Constructs a light which simulates the Sun based on a given time and location on Earth. |
|
Dispose() | Actively reclaims unmanaged resources that this instance uses. (Inherited from CommonObject.) |
|
Dispose(Boolean) |
For derived class implementers.
This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. Also, you must call the base virtual method within your overriding method. (Inherited from CommonObject.) |
|
Duplicate | Constructs a deep (full) copy of this object. (Inherited from GeometryBase.) |
|
DuplicateShallow | Constructs a light copy of this object. By "light", it is meant that the same underlying data is used until something is done to attempt to change it. For example, you could have a shallow copy of a very heavy mesh object and the same underlying data will be used when doing things like inspecting the number of faces on the mesh. If you modify the location of one of the mesh vertices, the shallow copy will create a full duplicate of the underlying mesh data and the shallow copy will become a deep copy. (Inherited from GeometryBase.) |
|
EnsurePrivateCopy | If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want. (Inherited from CommonObject.) |
|
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.) |
|
Finalize() | Passively reclaims unmanaged resources when the class user did not explicitly call Dispose(). (Inherited from CommonObject.) |
|
GetAttenuation | Gets the attenuation settings (ignored for "directional" and "ambient" lights). attenuation = 1/(a0 + da1 + d^2a2) where d = distance to light. |
|
|
GetBoundingBox(Boolean) | Boundingbox solver. Gets the world axis aligned boundingbox for the geometry. (Inherited from GeometryBase.) |
|
|
GetBoundingBox(Plane) | Aligned Boundingbox solver. Gets the plane aligned boundingbox. (Inherited from GeometryBase.) |
|
GetBoundingBox(Transform) | Aligned Boundingbox solver. Gets the world axis aligned boundingbox for the transformed geometry. (Inherited from GeometryBase.) |
|
GetBoundingBox(Plane, Box) | Aligned Boundingbox solver. Gets the plane aligned boundingbox. (Inherited from GeometryBase.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetObjectData | Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object. (Inherited from CommonObject.) |
|
GetSpotLightRadii | Gets the spot light radii. |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetUserString | Gets user string from this geometry. (Inherited from GeometryBase.) |
|
GetUserStrings | Gets a copy of all (user key string, user value string) pairs attached to this geometry. (Inherited from GeometryBase.) |
|
IsValidWithLog | Determines if an object is valid. Also provides a report on errors if this object happens not to be valid. (Inherited from CommonObject.) |
|
MakeDeformable | If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling. (Inherited from GeometryBase.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MemoryEstimate | Computes an estimate of the number of bytes that this object is using in memory. (Inherited from GeometryBase.) |
|
NonConstOperation |
For derived classes implementers.
Defines the necessary implementation to free the instance from being const.
(Inherited from CommonObject.) |
|
OnSwitchToNonConst | Is called when a non-const operation occurs. (Inherited from GeometryBase.) |
|
Rotate | Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). (Inherited from GeometryBase.) |
|
Scale | Scales the object by the specified factor. The scale is centered at the origin. (Inherited from GeometryBase.) |
|
SetAttenuation | Sets the attenuation settings (ignored for "directional" and "ambient" lights). attenuation = 1/(a0 + da1 + d^2a2) where d = distance to light. |
|
SetUserString | Attach a user string (key,value combination) to this geometry. (Inherited from GeometryBase.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
Transform | Transforms the geometry. If the input Transform has a SimilarityType of OrientationReversing, you may want to consider flipping the transformed geometry after calling this function when it makes sense. For example, you may want to call Flip() on a Brep after transforming it. (Inherited from GeometryBase.) |
|
Translate(Vector3d) | Translates the object along the specified vector. (Inherited from GeometryBase.) |
|
Translate(Double, Double, Double) | Translates the object along the specified vector. (Inherited from GeometryBase.) |
Supported in: 6.0.16224.21491, 5D58w