Light

Light class

Represents a light that shines in the modeling space.

Inheritence: Rhino.Runtime.CommonObjectRhino.Geometry.GeometryBaseLight
Derived Classes:

Namespace: Rhino.Geometry
Light: references

Constructors (5)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

GeometryBase(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Light()

Initializes a new light.

Light(SerializationInfo info, StreamingContext context)

Protected constructor used in serialization.

Properties (42)

Ambient

Gets or sets the ambient color.

AttenuationType

Get the type of attenuation for this light.

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.

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

HasBrepForm

Returns True if the Brep.TryConvertBrep function will be successful for this object

HasUserData

Gets True if this class has any custom information attached to it through UserData.

HotSpot

The hot spot setting runs from 0.0 to 1.0 and is used to provides a linear interface for controlling 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.

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.

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.

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.

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.

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.

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

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).

ShadowIntensity

Gets or sets the shadow intensity for the light.

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 controlling 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.

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

UserStringCount

Gets the amount of user strings.

Width

Gets or sets the width in linear and rectangular lights.
(ignored for non-linear/rectangular lights.)

Methods (43)

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.

ConstructConstObject(object parentObject, int subobjectIndex)

Assigns a parent object and a sub-object index to this.

CreateSunLight(double northAngleDegrees, double azimuthDegrees, double altitudeDegrees)

Constructs a light that represents the Sun.

CreateSunLight(double northAngleDegrees,DateTime when, double latitudeDegrees, double longitudeDegrees)

Constructs a light which simulates the Sun based on a given time and location on Earth.

CreateSunLight(Sun sun)

Constructs a light which simulates a Rhino.Render.Sun .

DataCRC(uint currentRemainder)

Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical.

DeleteAllUserStrings()

DeleteUserString(string key)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

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.

Dispose(bool disposing)

Overridden in order to destroy local display cache information

Duplicate()

Constructs a deep (full) copy of this object.

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.

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.

FromBase64String(int archive3dm, int opennurbs, string base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(string json)

Create a CommonObject instance from a JSON string

GeometryEquals(GeometryBase first, GeometryBase second)

Determines if two geometries equal one another, in pure geometrical shape. This version only compares the geometry itself and does not include any user data comparisons. This is a comparison by value: for two identical items it will be true, no matter where in memory they may be stored.

GeometryReferenceEquals(GeometryBase one, GeometryBase other)

Determines if two objects are respectively shallow copies, new managed instantiations of the same geometry, or similar internal references to the exact same geometry, both in managed and in unmanaged code.

GetAttenuation(double d)

Gets the attenuation settings (ignored for "directional" and "ambient" lights).
attenuation = 1/(a0 + d*a1 + d^2*a2) where d = distance to light.

GetBoundingBox(bool accurate)

Bounding box solver. Gets the world axis aligned bounding box for the geometry.

GetBoundingBox(Plane plane, out Box worldBox)

Aligned Bounding box solver. Gets the plane aligned bounding box.

GetBoundingBox(Plane plane)

Aligned Bounding box solver. Gets the plane aligned bounding box.

GetBoundingBox(Transform xform)

Aligned Bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.

GetObjectData(SerializationInfo info,StreamingContext context)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

GetSpotLightRadii(out double innerRadius, out double outerRadius)

Gets the spot light radii.

GetUserString(string key)

Gets user string from this geometry.

GetUserStrings()

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

IsValidWithLog(out string log)

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

MakeDeformable()

If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.

MemoryEstimate()

Computes an estimate of the number of bytes that this object is using in memory.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

NonConstOperation()

Destroy cache handle

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

OnSwitchToNonConst()

Is called when a non-constant operation occurs.

Rotate(double angleRadians, Vector3d rotationAxis, Point3d rotationCenter)

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).

Scale(double scaleFactor)

Scales the object by the specified factor. The scale is centered at the origin.

SetAttenuation(double a0, double a1, double a2)

Sets the attenuation settings (ignored for "directional" and "ambient" lights).
attenuation = 1/(a0 + d*a1 + d^2*a2) where d = distance to light.

SetUserString(string key, string value)

Attach a user string (key,value combination) to this geometry.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

Transform(Transform xform)

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.

Translate(double x, double y, double z)

Translates the object along the specified vector.

Translate(Vector3d translationVector)

Translates the object along the specified vector.

Fields (3)

ConstantAttenuationVector

Vector denoting a constant light attenuation.

InverseSquaredAttenuationVector

Vector denoting an inverse squared light attenuation.

LinearAttenuationVector

Vector denoting a linear light attenuation.

Nothing found