BoxOperator Class
Generates 3D meshes from polygons using values for bottom and top elevation.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEOperators assembly)
Syntax
public class BoxOperator : UnaryOperator
Remarks
This operator takes a polygon and extrudes it into a mesh using a lower and upper limit. A typical use case is to visualize airspaces in 3D.
![]() |
One mesh each will be created for the top, bottom, side and holes. Edges will be set on the meshes so that they can be visualized using a LineVisualizer. Horizontal lines are created on the top and bottom meshes while vertical lines are created on the side and hole meshes. The meshes will have the attribute surfaceType set to one of the values in the table. Use this attribute in your visualizers to handle different visualization use cases e.g. when only the side meshes should be visible but edges from all of the meshes should be drawn, or if you simply want different colors for different parts of the box.
surfaceType values
Value | Type | Description |
---|---|---|
top | Atom | Set on the mesh that represents the top lid of the box. |
bottom | Atom | Set on the mesh that represents the bottom lid of the box. |
side | Atom | Set on the mesh that represents the side of the box. |
hole | Atom | Set on the meshes that represent holes in the box. |
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Operator
UnaryOperator
BoxOperator
Platforms
Windows, Linux, Android
BoxOperator Members
The BoxOperator type has the following members.
Constructors
Name | Description |
---|---|
BoxOperator | Initializes a new instance of the BoxOperator class. |
Properties
Name | Description |
---|---|
BottomElevation | Gets or sets the bottom elevation of the generated box. |
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 |
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 BoxOperator 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 BoxOperator represents. Inherited from EngineObject |
TopElevation | Gets or sets the top elevation of the generated box. |
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 |
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 |