Properties_T_Rhino_Geometry_Light - mcneel/rhinocommon-api-docs GitHub Wiki

Light Properties

The Light type exposes the following members.

Properties

 

Name Description
Public property Ambient Gets or sets the ambient color.
Public property AttenuationVector Gets or Sets the attenuation vector.
Public property CoordinateSystem Gets a value, determined by LightStyle, that explains whether the camera directions are relative to World or Camera spaces.
Public propertyCode example Diffuse Gets or sets the diffuse color.
Public property Direction Gets or sets the vector direction of the camera.
Public property HasBrepForm Returns true if the Brep.TryConvertBrep function will be successful for this object (Inherited from GeometryBase.)
Public property HasUserData Gets true if this class has any custom information attached to it through UserData. (Inherited from CommonObject.)
Public property 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.
Public property Id Gets the ID of this light.
Public property Intensity Gets or sets the light intensity.
Public property IsDeformable true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling. (Inherited from GeometryBase.)
Public property IsDirectionalLight Gets a value indicating whether the light style is LightStyle CameraDirectional or WorldDirectional.
Public property 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.)
Public property IsEnabled Gets or sets a value that defines if the light is turned on (true) or off (false).
Public property IsLinearLight Gets a value indicating whether the light style is LightStyle WorldLinear.
Public property IsPointLight Gets a value indicating whether the light style is LightStyle CameraPoint or WorldPoint.
Public property IsRectangularLight Gets a value indicating whether the light style is LightStyle WorldRectangular.
Public property IsSpotLight Gets a value indicating whether the light style is LightStyle CameraSpot or WorldSpot.
Public property IsSunLight Gets a value indicating whether this object is a Sun light.
Public property IsValid Tests an object to see if it is valid. (Inherited from CommonObject.)
Public property Length Gets or sets the height in linear and rectangular lights. (ignored for non-linear/rectangular lights.)
Public property LightStyle Gets or sets a light style on this camera.
Public property Location Gets or sets the light or 3D position or location.
Public property Name Gets or sets the spot light name.
Public property ObjectType Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. (Inherited from GeometryBase.)
Public property PerpendicularDirection Gets a perpendicular vector to the camera direction.
Public property PowerCandela Gets or sets the light power in candelas (cd).
Public property PowerLumens Gets or sets the light power in lumens (lm).
Public property PowerWatts Gets or sets the light power in watts (W).
Public property Specular Gets or sets the specular color.
Public property SpotAngleRadians Gets or sets the spot angle in radians. Ignored for non-spot lights.

angle = 0 to pi/2 (0 to 90 degrees).

Public property 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.
Public property SpotLightShadowIntensity Gets or sets the spot light shadow intensity. (ignored for non-spot lights.)
Public property UserData List of custom information that is attached to this class. (Inherited from CommonObject.)
Public property 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.)
Public property UserStringCount Gets the amount of user strings. (Inherited from GeometryBase.)
Public property Width Gets or sets the width in linear and rectangular lights. (ignored for non-linear/rectangular lights.)
  Back to Top

See Also

Reference

Light Class
Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️