LineStyle Class
Abstract base class for all line styles.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public abstract class LineStyle : ResourceObjectRemarks
LineStyle is the abstract base class for all line styles that can be used to render lines and polygon edges. The most commonly used sub-class is probably DashedLineStyle, which can be used to draw dashed lines. A line style is used by attaching it to the LineVisualizer.Style property of a LineVisualizer.
Carmenta Engine provides a number of predefined line styles, available both in Carmenta Studio and as static properties of this class. Note that the last three of these are implemented as LayeredLineStyle, and that the red color is taken from the LineVisualizer and can be replaced.
 |
Predefined line styles in Carmenta Engine
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
LineStyle
ComplexLineStyle
DashedLineStyle
LayeredLineStyle
Platforms
Windows, Linux, Android
LineStyle Members
The LineStyle type has the following members.
Properties
| Name | Description |
|---|---|
 Crosses1 | Gets the predefined line style used to draw lines in the crosses1 style. |
| Crosses2 | Gets the predefined line style used to draw lines in the crosses2 style. |
| Dashes1 | Gets the predefined line style used to draw lines in the dashes1 style. |
| Dashes2 | Gets the predefined line style used to draw lines in the dashes2 style. |
| Dashes3 | Gets the predefined line style used to draw lines in the dashes3 style. |
| Dashes4 | Gets the predefined line style used to draw lines in the dashes4 style. |
| Dashes5 | Gets the predefined line style used to draw lines in the dashes5 style. |
| Dashes6 | Gets the predefined line style used to draw lines in the dashes6 style. |
| Dashes7 | Gets the predefined line style used to draw lines in the dashes7 style. |
| Dashes8 | Gets the predefined line style used to draw lines in the dashes8 style. |
| Dashes9 | Gets the predefined line style used to draw lines in the dashes9 style. |
| Diamonds | Gets the predefined line style used to draw lines in the diamonds style. |
| Dots1 | Gets the predefined line style used to draw lines in the dots1 style. |
| Dots2 | Gets the predefined line style used to draw lines in the dots2 style. |
| Double1 | Gets the predefined line style used to draw lines in the double1 style. |
| Double2 | Gets the predefined line style used to draw lines in the double2 style. |
| Highway1 | Gets the predefined line style used to draw lines in the highway1 style. |
| Highway2 | Gets the predefined line style used to draw lines in the highway2 style. |
| Highway3 | Gets the predefined line style used to draw lines in the highway3 style. |
| IsDisposed | Gets a value that tells whether the current LineStyle has been disposed. Inherited from EngineObject |
| Marks1 | Gets the predefined line style used to draw lines in the marks1 style. |
| Marks2 | Gets the predefined line style used to draw lines in the marks2 style. |
| Name | Gets or sets the name of the LineStyle. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current LineStyle represents. Inherited from EngineObject |
| Pluses1 | Gets the predefined line style used to draw lines in the pluses1 style. |
| Pluses2 | Gets the predefined line style used to draw lines in the pluses2 style. |
| Railway1 | Gets the predefined line style used to draw lines in the railway1 style. |
| Railway2 | Gets the predefined line style used to draw lines in the railway2 style. |
| SolidLine | Gets the predefined line style that is used to draw solid lines. |
| Spikes1 | Gets the predefined line style used to draw lines in the spikes1 style. |
| Spikes2 | Gets the predefined line style used to draw lines in the spikes2 style. |
| Spikes3 | Gets the predefined line style used to draw lines in the spikes3 style. |
| Squares | Gets the predefined line style used to draw lines in the squares style. |
| Triple1 | Gets the predefined line style used to draw lines in the triple1 style. |
| Triple2 | Gets the predefined line style used to draw lines in the triple2 style. |
| 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 |