Sun Class

Sun Class

Represents the Sun on a little portion of Earth.
Inheritance Hierarchy

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public class Sun : DocumentOrFreeFloatingBase, IDisposable
Public Class Sun
	Inherits DocumentOrFreeFloatingBase
	Implements IDisposable

The Sun type exposes the following members.

Constructors
  NameDescription
Public methodSun
Create a non-document controlled Sun
Top
Properties
  NameDescription
Public propertyAltitude
Get the altitude for the sun. To set use SetPosition(azimuth, altitude)
Public propertyAzimuth
Get the azimuth for the sun. To set use SetPosition(azimuth, altitude)
Public propertyDaylightSaving
Daylight savings time
Public propertyDaylightSavingMinutes
Daylight saving minutes
Public propertyEnabled
Turn the sun on/off in this document.
Public propertyLatitude
Public propertyLight
Get a Light which represents the sun. If manual control is in effect, no sun calculation is performed; the function uses the values last used in calls to Azimuth, Altitude or Vector. If manual control is not in effect, the observer's position, date, time, time zone and daylight saving values are used to calculate the position of the sun.
Public propertyLongitude
Public propertyManualControl
Set angles directly or use place/date/time
Public propertyNorth
Angle in degrees on world X-Y plane that should be considered north in the model. Angle is measured starting at X-Axis and travels counterclockwise. Y-Axis would be a north angle of 90 degrees.
Public propertySkylightOn Obsolete.
Turn skylight on or off.
Public propertyTimeZone
Measured in hours += UTC
Public propertyVector
Top
Methods
  NameDescription
Public methodStatic memberAltitudeFromValues
Public methodBeginChange
Call this function before making any change to this object (calling a setter) otherwise undo will not work correctly. Calls to BeginChange must be paired with a call to EndChange.
(Inherited from DocumentOrFreeFloatingBase.)
Public methodStatic memberColorFromAltitude
Get sun color based on altitude.
Public methodCopyFrom (Overrides FreeFloatingBaseCopyFrom(FreeFloatingBase).)
Public methodDispose
Releases all resources used by the Sun
Public methodEndChange
See BeginChange
(Inherited from DocumentOrFreeFloatingBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize (Overrides FreeFloatingBaseFinalize.)
Public methodGetDateTime
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberHere
Public methodStatic memberJulianDay
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetDateTime
Public methodSetPosition(Double, Double)
Sets position of the Sun based on azimuth and altitude values. Using this function will also set sun to manual.
Public methodSetPosition(DateTime, Double, Double)
Sets position of the sun based on physical location and time.
Public methodStatic memberSunDirection
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodStatic memberTwilightZone
Top
Events
  NameDescription
Public eventStatic memberChanged
This event is raised when a Sun property value is changed.
Top
Version Information

Rhino for Windows

Supported in: 6.14
See Also

T:Rhino.Render.Sun