Click or drag to resize

ClsC6xBaseClsC6Scene Class

Scene class for ClsC6xBase.

This class will trigger SceneControlChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.LightingClsC6xBaseClsC6Dimming
    Crestron.SimplSharpPro.LightingClsC6xBaseClsC6Scene

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public sealed class ClsC6Scene : ClsC6xBaseClsC6Dimming

The ClsC6xBaseClsC6Scene type exposes the following members.

Properties
 NameDescription
Public propertyAnyLightsOnFeedback Property to indicate that at least one affected light in the scene is above 0%. This property is not supported for Off This provides a way to determine which state will be triggered by the next call to Toggle.

This property will trigger SceneControlChange event with SceneAnyLightsOnEventId.

Public propertyLightsDown Property to lower the level of the lights in the scene. The lights will continue fading down until the property value is false, or until the lights reach 0% (or the lower limit). This property is not supported for Off scene type.
(Inherited from ClsC6xBaseClsC6Dimming)
Public propertyLightsDownFeedback Property to indicate that the lights in the scene are fading down. This property is not supported for Off scene type.

This property will trigger SceneControlChange event with SceneLightsDownEventId.


(Inherited from ClsC6xBaseClsC6Dimming)
Public propertyLightsUp Property to raise the level of the lights in the last (most recently recalled) scene. The lights will continue fading up until the property value is true, or until the lights reach 100% (or the upper limit). This property is not supported for Off scene type.
(Inherited from ClsC6xBaseClsC6Dimming)
Public propertyLightsUpFeedback Property to indicate that the lights in the scene are fading up. This property is not supported for Off scene type.

This property will trigger SceneControlChange event with SceneLightsUpEventId.


(Inherited from ClsC6xBaseClsC6Dimming)
Public propertyNumber Scene Number, this is property is supported for Standard scene type only. For other scene types the value will be 0.
(Inherited from ClsC6xBaseClsC6Dimming)
Public propertyParent Parent for ClsC6xBaseClsC6Dimming and ClsC6xBaseClsC6Scene classes.
(Inherited from ClsC6xBaseClsC6Dimming)
Public propertyRecallingFeedback Property to indicate that the scene is being recalled.

This property will trigger SceneControlChange event with SceneRecallingEventId.

Public propertyRecallingLightsOffFeedback Property to indicate that the lights in the scene are being turned off. This property is not supported for Off

This property will trigger SceneControlChange event with SceneRecallingLightsOffEventId.

Public propertySelectedFeedback Property to indicate that the scene has been selected. If another scene is engaged that affects any of the same lights in the scene, this will set the SelectedFeedback value to 'false' even if the target level for a given light doesn't change.

This property will trigger SceneControlChange event with SceneSelectedEventId.

Public propertyType Scene Type.
(Inherited from ClsC6xBaseClsC6Dimming)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from ClsC6xBaseClsC6Dimming)
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodLightsOff Method to turn off the lights in the scene. This method is not supported for Off. A second call to this method while the lights are fading will immediately cut the lights to 0%. This method has no effect on the shades; thus this method is intended for use only if the scene does not include shades.
Public methodRecall Method to recall the scene. A second call to this method while the lights are fading will immediately cut the lights to 0%.
Public methodToggle Method to toggle the scene between the On and Off states. This property is not supported for Off A second call to this method while the lights are fading will immediately cut the lights to the target levels.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also