CustomPropagationProxy Class
A proxy for a custom propagation in map configurations, representing a non-standard propagation model for line-of-sight, or for radio propagation etc.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public class CustomPropagationProxy : PropagationRemarks
A custom propagation is a .NET, C++ or Java object that implements the ICustomPropagation interface, which can represent a non-standard propagation model for line-of-sight or other propagation models for radio, sound, ballistic trajectories, etc. In the folder samples/CustomObjects you will find an example with a non-standard line-of-sight propagation model that assumes that forests and shrubs are semitransparent, and the generated raster indicates the probability of sight.
If you have written a custom propagation and want to use it in a map configuration, you must define a CustomPropagationProxy that you use as the customPropagation property of an instance of LineOfSightOperator or one of its derived classes. The presence of the proxy object will make the operator skip its standard line-of-sight propagation algorithm along each ray from the observer; instead, the operator will delegate the calculation to your custom object by calling its Propagate method.
There are two different ways to connect the custom propagation object to the proxy:
If the Api, LibraryName and ClassName properties are set, the proxy will automatically load the specified library and create an instance of the custom propagation.
The application code can itself create the custom propagation instance and pass it to the proxy via a constructor or by setting the CustomPropagation property.
The same ICustomPropagation object cannot be shared by several CustomPropagationProxy objects. Assigning an ICustomPropagation object either directly to the CustomPropagationProxy constructor or by setting the CustomPropagation property will always clone the object. Make sure not to keep the ICustomPropagation object after assigning it; instead fetch the cloned instance via the property CustomPropagation.
The same CustomPropagationProxy object cannot be shared by two operators. Carmenta Studio protects you from creating such an invalid sharing, since the option "Create Reference Here" is omitted from the context menu when you right-button-drag-and-drop a CustomPropagationProxy object. And an attempt to create an invalid sharing in application code will cause an exception to be thrown.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Propagation
CustomPropagationProxy
Platforms
Windows, Linux, Android
See Also
Reference
CustomObjects Module
ICustomPropagation
CustomPropagationContext
LineOfSightOperator.CustomPropagation
CustomPropagationProxy Members
The CustomPropagationProxy type has the following members.
Constructors
| Name | Description |
|---|---|
| CustomPropagationProxy | Initializes a new instance of the CustomPropagationProxy class. |
Properties
| Name | Description |
|---|---|
| Api | Gets the API the custom propagation is implemented with. |
| ClassName | Gets the name of the class implementing the custom propagation. |
| CustomPropagation | Gets or sets the custom propagation instance. |
| IsDisposed | Gets a value that tells whether the current CustomPropagationProxy has been disposed. Inherited from EngineObject |
| LibraryName | Gets the name of the library containing the custom propagation. |
| Name | Gets or sets the name of the propagation object. Inherited from Propagation |
| NativeHandle | Gets the native Carmenta Engine kernel object the current CustomPropagationProxy represents. Inherited from EngineObject |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
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 |