ShadeOperator Class
An operator that produces shaded images from elevation rasters.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEOperators assembly)
Syntax
public class ShadeOperator : UnaryOperator
Remarks
A ShadeOperator calculates how much light from the sun that hits each raster cell in an elevation raster.
Cells where the ground is directed straight towards the sun get the maximum value, while cells where the ground is directed 90 degrees or more from away from the sun get the value 0. In general, if the ground is directed the angle alpha away from the sun (where alpha ≤ 90°), the cells will get the value cos(alpha) * maximum. But this formula assumes that you have not exaggerated the topography via the HeightFactor property.
This operator considers only the local slope of the ground, so it will ignore shadows that are cast by hills (such shadows can be computed by the ShadowOperator).
The position of the sun is specified by the View.SunPosition property.
By default, the operator will attach a RasterVisualizer with a grayscale color ramp to its output.
![]() |
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Operator
UnaryOperator
ShadeOperator
Platforms
Windows, Linux, Android
ShadeOperator Members
The ShadeOperator type has the following members.
Constructors
Name | Description |
---|---|
ShadeOperator | Initializes a new instance of the ShadeOperator class. |
Properties
Name | Description |
---|---|
Description | Gets or sets a short description of the operator. Inherited from Operator |
DisplayName | Gets or sets a display name for the operator. Inherited from Operator |
HeightFactor | Gets or sets an extra factor multiplied to all elevations before light calculations. |
Input | Gets or sets the input operator, from which this operator reads features. Inherited from UnaryOperator |
IsDisposed | Gets a value that tells whether the current ShadeOperator has been disposed. Inherited from EngineObject |
IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the operator. Inherited from Operator |
Name | Gets or sets the name of the operator. Inherited from Operator |
NativeHandle | Gets the native Carmenta Engine kernel object the current ShadeOperator represents. Inherited from EngineObject |
OutputBitDepth | Gets or sets a value specifying the bit depth of the produced rasters. |
OutputUndefinedValues | Gets or sets a value indicating if the operator should output undefined values where the input is undefined. |
OutputVisualizer | Gets or sets a value indicating if the operator should attach a visualizer to the output rasters. |
IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
VisualizerFilter | Gets or sets the filter to use when a visualizers are attached to the output rasters. |
Methods
Name | Description |
---|---|
Clone | Creates a copy of an object. Inherited from EngineObject |
Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from Operator |
FlushCache | Marks the layer as flushed which will release cached resources during the next update. Inherited from Operator |
GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from Operator |
GetFeatures | Overloaded. Gets features from the operator chain. Inherited from Operator |
GetLocalizedDescription | Gets a localized version of the operator description in a specific language. Inherited from Operator |
GetLocalizedDisplayName | Gets a localized version of the operator display name in a specific language. Inherited from Operator |
GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Operator |
GetRasterFeature | Overloaded. Gets raster features from the operator chain and merges them into a single raster. Inherited from Operator |
HasLocalizedDescription | Checks if a localized version of the operator description is available in a specific language. Inherited from Operator |
HasLocalizedDisplayName | Checks if a localized version of the operator display name is available in a specific language. Inherited from Operator |
HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Operator |
SetLocalizedDescription | Sets a operator description in a specific language. Inherited from Operator |
SetLocalizedDisplayName | Sets a operator display name in a specific language. Inherited from Operator |
SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the operator, for a specific language. Inherited from Operator |