CircleCrossSection Class

A circular cross section used with CorridorOperator3D

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CEOperators assembly)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

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
  EngineObject
    ResourceObject
      CrossSection
        CircleCrossSection

Platforms

Windows, Linux, Android

CircleCrossSection Members

The CircleCrossSection type has the following members.

Constructors

Name	Description
CircleCrossSection	Initializes a new instance of the CircleCrossSection class.

Properties

Name	Description
ArcAccuracy	Gets or sets the number of points in the circle.
IsDisposed	Gets a value that tells whether the current CircleCrossSection has been disposed. Inherited from EngineObject
Name	Gets or sets the name of the CircleCrossSection. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current CircleCrossSection represents. Inherited from EngineObject
Radius	Gets or sets the radius used by circle cross section, in meters.
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

CircleCrossSection Class

A circular cross section used with CorridorOperator3D

Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Operators.hpp>
Dynamic link library: CEOperators.Cpp.dll
Library: CEOperators.Cpp.lib

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C++

class CircleCrossSection : public CrossSection

C++ Smart Pointer Declaration

typedef Ptr<CircleCrossSection> CircleCrossSectionPtr;

Remarks

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

EngineObject
  ResourceObject
    CrossSection
      CircleCrossSection

Platforms

Windows, Linux, Android

CircleCrossSection Members

The CircleCrossSection type has the following members.

Constructors

Name	Description
CircleCrossSection	Initializes a new instance of the CircleCrossSection class.

Properties

Name	Description
arcAccuracy	Gets or sets the number of points in the circle.
name	Gets or sets the name of the CircleCrossSection. Inherited from ResourceObject
radius	Gets or sets the radius used by circle cross section, in meters.
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
equals	Determines whether this instance is equal to another. Inherited from EngineObject

CircleCrossSection Class

A circular cross section used with CorridorOperator3D

Package: com.carmenta.engine.operators
JAR file: CEOperators.Java.jar

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Java

public class CircleCrossSection extends CrossSection

Remarks

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

java.lang.Object
  EngineObject
    ResourceObject
      CrossSection
        CircleCrossSection

Platforms

Windows, Linux, Android

CircleCrossSection Members

The CircleCrossSection type has the following members.

Constructors

Name	Description
CircleCrossSection	Initializes a new instance of the CircleCrossSection class.

Properties

Name	Description
arcAccuracy	Gets or sets the number of points in the circle.
isDisposed	Gets a value that tells whether the current CircleCrossSection has been disposed. Inherited from EngineObject
name	Gets or sets the name of the CircleCrossSection. Inherited from ResourceObject
radius	Gets or sets the radius used by circle cross section, in meters.
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

CircleCrossSection Class

A circular cross section used with CorridorOperator3D

Module: Carmenta.Engine.Operators (in Operators.pyd)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Python

class CircleCrossSection ( CrossSection )

Remarks

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

EngineObject
  ResourceObject
    CrossSection
      CircleCrossSection

Platforms

Windows, Linux, Android

CircleCrossSection Members

The CircleCrossSection type has the following members.

Constructors

Name	Description
CircleCrossSection	Initializes a new instance of the CircleCrossSection class.

Properties

Name	Description
arcAccuracy	Gets or sets the number of points in the circle.
name	Gets or sets the name of the CircleCrossSection. Inherited from ResourceObject
radius	Gets or sets the radius used by circle cross section, in meters.
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
equals	Determines whether this instance is equal to another. Inherited from EngineObject

CircleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CircleCrossSection Members

CircleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CircleCrossSection Members

CircleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CircleCrossSection Members

CircleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CircleCrossSection Members