SunAndShadowSettings

Public Class

The SunAndShadowSettings class represents the sun control.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.SunAndShadowSettings

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class SunAndShadowSettings : Element

The SunAndShadowSettings type exposes the following members.

Properties

Name

Description

Public Property

ActiveFrame

Identifies the active animation frame for a single-day or multi-day study, starting at 1.0 for the first frame and incrementing in intervals of 1.0.

Public Property

ActiveFrameTime

Identifies the date and time of the SunAndShadowSettings element for the active frame.

Public Property

Altitude

Altitude setting (angle in radians). This is only relevant when dealing with a SunAndShadowSettings element that uses lighting mode.

Public Property

AssemblyInstanceId

The id of the assembly instance to which the element belongs.
(Inherited from Element)

Public Property

Azimuth

Azimuth setting (angle in radians). This is only relevant when dealing with a SunAndShadowSettings element that uses lighting mode.

Public Property
Code Example
BoundingBox

Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element)

Public Property
Category

Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element)

Public Property
Code Example
CreatedPhaseId

Id of a Phase at which the Element was created.
(Inherited from Element)

Public Property
Code Example
DemolishedPhaseId

Id of a Phase at which the Element was demolished.
(Inherited from Element)

Public Property
Code Example
DesignOption

Returns the design option to which the element belongs.
(Inherited from Element)

Public Property
Document

Returns the Document in which the Element resides.
(Inherited from Element)

Public Property
EndDateAndTime

Identifies the end date and time.

Public Property
Code Example
Geometry

Retrieves the geometric representation of the element.
(Inherited from Element)

Public Property

GroundPlaneHeight

Identifies the ground plane height.

Public Property

GroundPlaneLevelId

Identifies the element id of the Ground Plane level for the SunAndShadowSettings element.

Public Property

GroupId

The id of the group to which an element belongs.
(Inherited from Element)

Public Property
Code Example
Id

A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element)

Public Property
IsModifiable

Identifies if the element is modifiable.
(Inherited from Element)

Public Property
IsTransient

Indicates whether an element is transient or permanent.
(Inherited from Element)

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element)

Public Property

Latitude

Identifies the current latitude used by the SunAndShadowSettings element.

Public Property

LevelId

The id of the level associated with the element.
(Inherited from Element)

Public Property
Code Example
Location

This property is used to find the physical location of an element within a project.
(Inherited from Element)

Public Property

Longitude

Identifies the current longitude used by the SunAndShadowSettings element.

Public Property
Name

A human readable name for the Element.
(Inherited from Element)

Public Property

NumberOfFrames

Identifies the total number of animation frames for a single-day or multi-day study.

Public Property

OwnerViewId

The id of the view that owns the element.
(Inherited from Element)

Public Property
Code Example
Parameter.BuiltInParameter.

Retrieves a parameter from the element given a parameter id.
(Inherited from Element)

Public Property
Parameter.Definition.

Retrieves a parameter from the element based on its definition.
(Inherited from Element)

Public Property
Parameter.Guid.

Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element)

Public Property
Code Example
Parameters

Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
ParametersMap

Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element)

Public Property
Pinned

Identifies if the element has been pinned to prevent changes.
(Inherited from Element)

Public Property

ProjectLocationId

Identifies the ProjectLocation element used by the SunAndShadowSettings element.

Public Property

ProjectLocationName

Identifies the name of the project location used by the SunAndShadowSettings element.

Public Property

RelativeToView

Identifies whether the SunAndShadowSettings element is relative to the view direction. This is only relevant for lighting mode.

Public Property
SharesSettings

Identifies whether settings are shared globally.

Public Property
StartDateAndTime

Identifies the start or current date and time.

Public Property
SunAndShadowType

Identifies the type of the SunAndShadowSettings element.

Public Property

SunriseToSunset

Identifies whether the current single day sun study is set to run from sunrise to sunset.

Public Property

TimeInterval

Identifies the time interval between animation frames.

Public Property
TimeZone

Identifies the time zone.

Public Property
Code Example
UniqueId

A stable unique identifier for an element within the document.
(Inherited from Element)

Public Property

UsesDST

Identifies whether the SunAndShadowSettings element is using daylight savings time.

Public Property

UsesGroundPlane

Identifies whether the SunAndShadowSettings element uses a ground plane.

Public Property
VersionGuid

Get the element version Guid.
(Inherited from Element)

Public Property

ViewSpecific

Identifies if the element is owned by a view.
(Inherited from Element)

Public Property

Visible

Visibility in current view for a per-view SunAndShadowSettings element.

Public Property
WorksetId

Get Id of the Workset which owns the element.
(Inherited from Element)

Methods

Name

Description

Public Method
ArePhasesModifiable

Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element)

Public Method
Static Member
CalculateTimeZone

Use Revit’s utilities to calculate the time zone for a given longitude and latitude.

Public Method
CanBeHidden

Indicates if the element can be hidden in the view.
(Inherited from Element)

Public Method

CanBeLocked

Identifies if the element can be locked.
(Inherited from Element)

Public Method

CanDeleteSubelement

Checks if given subelement can be removed from the element.
(Inherited from Element)

Public Method
CanHaveTypeAssigned.

Identifies if the element can have a type assigned.
(Inherited from Element)

Public Method
ChangeTypeId(ElementId)

Changes the type of the element.
(Inherited from Element)

Public Method

DeleteEntity

Deletes the existing entity created by %schema% in the element
(Inherited from Element)

Public Method
DeleteSubelement

Removes a subelement from the element.
(Inherited from Element)

Public Method
DeleteSubelements

Removes the subelements from the element.
(Inherited from Element)

Public Method

Dispose

(Inherited from Element)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

EvaluateAllParameterValues

Evaluates all the parameters’ values of the element.
(Inherited from Element)

Public Method

EvaluateParameterValues

Evaluate the parameters’ values of the element on the given parameter ID set.
(Inherited from Element)

Public Method

FitToModel

Adjust SunAndShadowSettings to fit around the current model geometry.

Public Method
Static Member

GetActiveSunAndShadowSettings

Returns the current SunAndShadowSettings element assigned to the active view for the supplied document.

Public Method
GetDependentElements

Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element)

Public Method
GetEntity

Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
(Inherited from Element)

Public Method

GetEntitySchemaGuids

Returns the Schema guids of any Entities stored in this element.
(Inherited from Element)

Public Method

GetExternalFileReference

Gets information pertaining to the external file referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReference

Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferenceExpanded

Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)

Public Method
GetExternalResourceReferences

Gets the map of the external resource references referenced by the element.
(Inherited from Element)

Public Method
GetExternalResourceReferencesExpanded

Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element)

Public Method

GetFrameAltitude

Identifies the altitude of the sun (angle in radians) for a specific frame.

Public Method

GetFrameAzimuth

Identifies the azimuth of the sun (angle in radians) for a specific frame.

Public Method

GetFrameTime

Identifies the date and time of the SunAndShadowSettings element for a given frame.

Public Method
Code Example
GetGeneratingElementIds

Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element)

Public Method
GetGeometryObjectFromReference

Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetMatchingPreset

Finds the name of the ‘per-document’ SunAndShadowSettings that matches the properties of this per-view element.

Public Method

GetMaterialArea

Gets the area of the material with the given id.
(Inherited from Element)

Public Method
GetMaterialIds

Gets the element ids of all materials present in the element.
(Inherited from Element)

Public Method

GetMaterialVolume

Gets the volume of the material with the given id.
(Inherited from Element)

Public Method

GetMonitoredLinkElementIds

Provides the link instance IDs when the element is monitoring.
(Inherited from Element)

Public Method

GetMonitoredLocalElementIds

Provides the local element IDs when the element is monitoring.
(Inherited from Element)

Public Method
GetOrderedParameters

Gets the parameters associated to the element in order.
(Inherited from Element)

Public Method
GetParameter

Retrieves a parameter from the element given identifier.
(Inherited from Element)

Public Method

GetParameterFormatOptions

Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element)

Public Method
GetParameters

Retrieves the parameters from the element via the given name.
(Inherited from Element)

Public Method

GetPhaseStatus

Gets the status of a given element in the input phase
(Inherited from Element)

Public Method
GetSubelements

Returns the collection of element subelements.
(Inherited from Element)

Public Method
GetSunrise

Identifies the sunrise time for the SunAndShadowSettings element at its current location and indicated date.

Public Method
GetSunset

Identifies the sunset time for the SunAndShadowSettings element at its current location and indicated date.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
Code Example
GetTypeId

Returns the identifier of this element’s type.
(Inherited from Element)

Public Method

GetValidTypes.

Obtains a set of types that are valid for this element.
(Inherited from Element)

Public Method
HasPhases

Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element)

Public Method

IsAfterStartDateAndTime

Checks whether the end date and time is valid.

Public Method

IsBeforeEndDateAndTime

Checks whether the start date and time is valid.

Public Method

IsCreatedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method

IsDemolishedPhaseOrderValid

Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)

Public Method
IsExternalFileReference

Determines whether this Element represents an external file.
(Inherited from Element)

Public Method

IsFrameValid

Checks whether the frame is valid for the supplied SunAndShadowSettings.

Public Method

IsGroundPlaneLevelValid

Checks whether the element represents a valid Ground Plane level.

Public Method
IsHidden

Identifies if the element has been permanently hidden in the view.
(Inherited from Element)

Public Method

IsMonitoringLinkElement

Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element)

Public Method

IsMonitoringLocalElement

Indicate whether an element is monitoring other local elements.
(Inherited from Element)

Public Method
IsPhaseCreatedValid

Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element)

Public Method
IsPhaseDemolishedValid

Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element)

Public Method

IsTimeIntervalValid

Checks whether the time interval is valid for the SunAndShadowType.

Public Method
IsValidType(ElementId)

Checks if given type is valid for this element.
(Inherited from Element)

Public Method
LookupParameter

Attempts to find a parameter on the element which has the given name.
(Inherited from Element)

Public Method

RefersToExternalResourceReference

Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element)

Public Method
RefersToExternalResourceReferences

Determines whether this Element uses external resources.
(Inherited from Element)

Public Method

SetEntity

Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

The SunAndShadowSettings element represents the settings applied to a project or view regarding the position, dates, time intervals and other options for the sun control and solar studies. To differentiate between the project and view settings, test the ViewSpecific or OwnerViewId property. If the element is not view-specific this element represents a project-wide setting. If the element is associated to a view, this element represents a per view SunAndShadowSettings. When you create a new view, a new view-specific SunAndShadowSettings element is automatically created for it.

Example

SunAndShadowSettings sunSettings = view.SunAndShadowSettings; // get current settings from view

// modify Sun and Shadow Settings
DateTime sunrise = sunSettings.GetSunrise(DateTime.SpecifyKind(new DateTime(2011, 4, 20), DateTimeKind.Local)); // sunrise on April 20, 2011
DateTime sunset = sunSettings.GetSunset(DateTime.SpecifyKind(new DateTime(2011, 4, 22), DateTimeKind.Local)); // sunset on April 22, 2011
sunSettings.SunAndShadowType = SunAndShadowType.MultiDayStudy;
sunSettings.StartDateAndTime = sunrise.AddHours(2); // start 2 hours after sunrise on April 20, 2011
sunSettings.EndDateAndTime = sunset.AddHours(-2); // end 2 hours before sunset on April 22, 2011
if (sunSettings.IsTimeIntervalValid(SunStudyTimeInterval.Hour)) // check that this interval is valid for this SunAndShadowType
    sunSettings.TimeInterval = SunStudyTimeInterval.Hour;

// check for validity of start and end times
if (!(sunSettings.IsAfterStartDateAndTime(sunSettings.EndDateAndTime)
    && sunSettings.IsBeforeEndDateAndTime(sunSettings.StartDateAndTime)))
    TaskDialog.Show("Error", "Start and End dates are invalid");

view.get_Parameter(BuiltInParameter.VIEW_GRAPH_SUN_PATH).Set(1); // turn on display of the sun path