← Back to carmenta.com
Carmenta Engine SDK Documentation
×

DashedLineStyle Class

Represents a line style that is used to draw dashed lines.

Namespace: Carmenta.Engine
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

C#
public class DashedLineStyle : LineStyle

Remarks

A DashedLineStyle is defined by a list of values that determine the length of dashes and the spaces between them. Each dash requires a corresponding space.

Tip

In 3D, dashed styles will be transformed into a bit pattern. Therefore a dashed style will look best if the length of each dash and space is a power of 2. In OpenGL the bit pattern is 16 bits long. In DirectX it is 32 bits long. As an example, the pattern 8, 4, 2, 2 will align perfectly in both OpenGL and DirectX.

The pattern will be affected by PixelSizeAdjustments. Since the scaled lengths will be saved into the bit pattern, a power of 2 pattern may not align perfectly depending on the settings.

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    ResourceObject
      LineStyle
        DashedLineStyle

Platforms

Windows, Linux, Android

DashedLineStyle Members

The DashedLineStyle type has the following members.

Constructors

NameDescription
DashedLineStyleInitializes a new instance of the DashedLineStyle class.

Properties

NameDescription
Static Crosses1Gets the predefined line style used to draw lines in the crosses1 style. Inherited from LineStyle
Static Crosses2Gets the predefined line style used to draw lines in the crosses2 style. Inherited from LineStyle
DashesGets the length of the dashes and the spaces between the dashes.
Static Dashes1Gets the predefined line style used to draw lines in the dashes1 style. Inherited from LineStyle
Static Dashes2Gets the predefined line style used to draw lines in the dashes2 style. Inherited from LineStyle
Static Dashes3Gets the predefined line style used to draw lines in the dashes3 style. Inherited from LineStyle
Static Dashes4Gets the predefined line style used to draw lines in the dashes4 style. Inherited from LineStyle
Static Dashes5Gets the predefined line style used to draw lines in the dashes5 style. Inherited from LineStyle
Static Dashes6Gets the predefined line style used to draw lines in the dashes6 style. Inherited from LineStyle
Static Dashes7Gets the predefined line style used to draw lines in the dashes7 style. Inherited from LineStyle
Static Dashes8Gets the predefined line style used to draw lines in the dashes8 style. Inherited from LineStyle
Static Dashes9Gets the predefined line style used to draw lines in the dashes9 style. Inherited from LineStyle
Static DiamondsGets the predefined line style used to draw lines in the diamonds style. Inherited from LineStyle
Static Dots1Gets the predefined line style used to draw lines in the dots1 style. Inherited from LineStyle
Static Dots2Gets the predefined line style used to draw lines in the dots2 style. Inherited from LineStyle
Static Double1Gets the predefined line style used to draw lines in the double1 style. Inherited from LineStyle
Static Double2Gets the predefined line style used to draw lines in the double2 style. Inherited from LineStyle
Static Highway1Gets the predefined line style used to draw lines in the highway1 style. Inherited from LineStyle
Static Highway2Gets the predefined line style used to draw lines in the highway2 style. Inherited from LineStyle
Static Highway3Gets the predefined line style used to draw lines in the highway3 style. Inherited from LineStyle
IsDisposedGets a value that tells whether the current DashedLineStyle has been disposed. Inherited from EngineObject
Static Marks1Gets the predefined line style used to draw lines in the marks1 style. Inherited from LineStyle
Static Marks2Gets the predefined line style used to draw lines in the marks2 style. Inherited from LineStyle
NameGets or sets the name of the DashedLineStyle. Inherited from ResourceObject
NativeHandleGets the native Carmenta Engine kernel object the current DashedLineStyle represents. Inherited from EngineObject
Static Pluses1Gets the predefined line style used to draw lines in the pluses1 style. Inherited from LineStyle
Static Pluses2Gets the predefined line style used to draw lines in the pluses2 style. Inherited from LineStyle
Static Railway1Gets the predefined line style used to draw lines in the railway1 style. Inherited from LineStyle
Static Railway2Gets the predefined line style used to draw lines in the railway2 style. Inherited from LineStyle
Static SolidLineGets the predefined line style that is used to draw solid lines. Inherited from LineStyle
Static Spikes1Gets the predefined line style used to draw lines in the spikes1 style. Inherited from LineStyle
Static Spikes2Gets the predefined line style used to draw lines in the spikes2 style. Inherited from LineStyle
Static Spikes3Gets the predefined line style used to draw lines in the spikes3 style. Inherited from LineStyle
Static SquaresGets the predefined line style used to draw lines in the squares style. Inherited from LineStyle
Static Triple1Gets the predefined line style used to draw lines in the triple1 style. Inherited from LineStyle
Static Triple2Gets the predefined line style used to draw lines in the triple2 style. Inherited from LineStyle
IUserProperties.UserPropertiesGets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

NameDescription
CloneCreates a copy of an object. Inherited from EngineObject
DisposeReleases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
EqualsDetermines whether this instance is equal to another. Inherited from EngineObject

By accessing the information on this site you accept our terms and conditions and privacy policy.
This site uses cookies to enhance your experience and provide additional functionality.

Accept