Light Class

Initializes a new light.

Protected constructor used in serialization.

Gets or sets the ambient color.

Get the type of attenuation for this light.

Gets or Sets the attenuation vector.

Gets a value, determined by LightStyle, that explains whether the camera directions are relative to World or Camera spaces.

Gets or sets the diffuse color.

Gets or sets the vector direction of the camera.

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

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

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

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.

Gets or sets the light intensity.

true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.

Gets a value indicating whether the light style is LightStyle CameraDirectional or WorldDirectional.

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.

Gets or sets a value that defines if the light is turned on (true) or off (false).

Gets a value indicating whether the light style is LightStyle WorldLinear.

Gets a value indicating whether the light style is LightStyle CameraPoint or WorldPoint.

Gets a value indicating whether the light style is LightStyle WorldRectangular.

Gets a value indicating whether the light style is LightStyle CameraSpot or WorldSpot.

Gets a value indicating whether this object is a Sun light.

Tests an object to see if it is valid.

Gets or sets the height in linear and rectangular lights.

(ignored for non-linear/rectangular lights.)

Gets or sets a light style on this camera.

Gets or sets the light or 3D position or location.

Gets or sets the spot light name.

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

Gets a perpendicular vector to the camera direction.

Gets or sets the light power in candelas (cd).

Gets or sets the light power in lumens (lm).

Gets or sets the light power in watts (W).

Gets or sets the shadow intensity for the light.

Gets or sets the specular color.

Gets or sets the spot angle in radians.

Ignored for non-spot lights.

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

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.

Gets or sets the spot light shadow intensity.

(ignored for non-spot lights.)

List of custom information that is attached to this class.

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

Gets the amount of user strings.

Gets or sets the width in linear and rectangular lights.

(ignored for non-linear/rectangular lights.)

If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.

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

Constructs a light which simulates a Sun.

Constructs a light that represents the Sun.

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

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.

Actively reclaims unmanaged resources that this instance uses.

Overridden in order to destroy local display cache information

Constructs a deep (full) copy of this object.

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.

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.

Determines whether the specified object is equal to the current object.

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

Gets the attenuation settings (ignored for "directional" and "ambient" lights).

attenuation = 1/(a0 + d*a1 + d^2*a2) where d = distance to light.

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

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

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

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

Serves as the default hash function.

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

Gets the spot light radii.

Gets the Type of the current instance.

Gets user string from this geometry.

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

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

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

Creates a shallow copy of the current Object.

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

Destroy cache handle

Is called when a non-constant operation occurs.

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

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

Sets the attenuation settings (ignored for "directional" and "ambient" lights).

attenuation = 1/(a0 + d*a1 + d^2*a2) where d = distance to light.

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

Create a JSON string representation of this object

Returns a string that represents the current object.

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.

Translates the object along the specified vector.

Translates the object along the specified vector.

Vector denoting a constant light attenuation.

Vector denoting an inverse squared light attenuation.

Vector denoting a linear light attenuation.