← Back to carmenta.com
Carmenta Engine SDK Documentation
×

CircleCrossSection Class

A circular cross section used with CorridorOperator3D

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEOperators assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C#
public class CircleCrossSection : CrossSection

Remarks

A CircleCrossSection is a corridor cross section in with the shape of a circle with properties radius and arc accuracy. Arc accuracy determines the number of points in the circle. A CircleCrossSection with arc accuracy 6 is shown below:

The black dot indicates the center of the corridor, and the circle vertices are shown in red.

Texturization

A corridor mesh created from a CircleCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 at the topmost cross section vertex, increasing clockwise around the cross section ending at 1 at the topmost vertex. The V parameter is mapped at 0 at the start of the corridor and at 1 at a distance in meters along the corridor defined by the CorridorOperator3D.TextureScaleFactorV property. The texture is repeated along the V axis until the end of the corridor.

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    ResourceObject
      CrossSection
        CircleCrossSection

Platforms

Windows, Linux, Android

CircleCrossSection Members

The CircleCrossSection type has the following members.

Constructors

NameDescription
CircleCrossSectionInitializes a new instance of the CircleCrossSection class.

Properties

NameDescription
ArcAccuracyGets or sets the number of points in the circle.
IsDisposedGets a value that tells whether the current CircleCrossSection has been disposed. Inherited from EngineObject
NameGets or sets the name of the CircleCrossSection. Inherited from ResourceObject
NativeHandleGets the native Carmenta Engine kernel object the current CircleCrossSection represents. Inherited from EngineObject
RadiusGets or sets the radius used by circle cross section, in meters.
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