TroughCrossSection Class

A trough cross section geometry for use 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

public class TroughCrossSection : CrossSection

Remarks

A TroughCrossSection is similar to a RectangleCrossSection but with the bottom corners truncated. In addition to the width and height properties of RectangleCrossSection, TroughCrossSection has the properties baseWidth and baseHeight defining how the corners are truncated.The shape is illustrated in the image below:

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

Texturization

A corridor mesh created from a TroughCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 at the top right corner, increasing clockwise around the cross section ending at 1 returning to the top right corner. 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
        TroughCrossSection

Platforms

Windows, Linux, Android

TroughCrossSection Members

The TroughCrossSection type has the following members.

Constructors

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

Properties

Name	Description
BaseHeight	Gets or sets the baseHeight used by this trough cross section.
BaseWidth	Gets or sets the base width used by this trough cross section.
Height	Gets or sets the height used by this cross section.
IsDisposed	Gets a value that tells whether the current TroughCrossSection has been disposed. Inherited from EngineObject
Name	Gets or sets the name of the TroughCrossSection. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current TroughCrossSection represents. Inherited from EngineObject
IUserProperties.UserProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
Width	Gets or sets the width used by this trough cross section.

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

TroughCrossSection Class

A trough cross section geometry for use with CorridorOperator3D.

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

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

Syntax

C++

class TroughCrossSection : public CrossSection

C++ Smart Pointer Declaration

typedef Ptr<TroughCrossSection> TroughCrossSectionPtr;

Remarks

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

Texturization

A corridor mesh created from a TroughCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 at the top right corner, increasing clockwise around the cross section ending at 1 returning to the top right corner. 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
      TroughCrossSection

Platforms

Windows, Linux, Android

TroughCrossSection Members

The TroughCrossSection type has the following members.

Constructors

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

Properties

Name	Description
baseHeight	Gets or sets the baseHeight used by this trough cross section.
baseWidth	Gets or sets the base width used by this trough cross section.
height	Gets or sets the height used by this cross section.
name	Gets or sets the name of the TroughCrossSection. Inherited from ResourceObject
IUserProperties::userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
width	Gets or sets the width used by this trough cross section.

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

TroughCrossSection Class

A trough cross section geometry for use 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 TroughCrossSection extends CrossSection

Remarks

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

Texturization

A corridor mesh created from a TroughCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 at the top right corner, increasing clockwise around the cross section ending at 1 returning to the top right corner. 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 Java)
  EngineObject
    ResourceObject
      CrossSection
        TroughCrossSection

Platforms

Windows, Linux, Android

TroughCrossSection Members

The TroughCrossSection type has the following members.

Constructors

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

Properties

Name	Description
baseHeight	Gets or sets the baseHeight used by this trough cross section.
baseWidth	Gets or sets the base width used by this trough cross section.
height	Gets or sets the height used by this cross section.
isDisposed	Gets a value that tells whether the current TroughCrossSection has been disposed. Inherited from EngineObject
name	Gets or sets the name of the TroughCrossSection. Inherited from ResourceObject
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
width	Gets or sets the width used by this trough cross section.

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

TroughCrossSection Class

A trough cross section geometry for use 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 TroughCrossSection ( CrossSection )

Remarks

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

Texturization

A corridor mesh created from a TroughCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 at the top right corner, increasing clockwise around the cross section ending at 1 returning to the top right corner. 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
      TroughCrossSection

Platforms

Windows, Linux, Android

TroughCrossSection Members

The TroughCrossSection type has the following members.

Constructors

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

Properties

Name	Description
baseHeight	Gets or sets the baseHeight used by this trough cross section.
baseWidth	Gets or sets the base width used by this trough cross section.
height	Gets or sets the height used by this cross section.
name	Gets or sets the name of the TroughCrossSection. Inherited from ResourceObject
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
width	Gets or sets the width used by this trough cross section.

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

TroughCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

TroughCrossSection Members

TroughCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

TroughCrossSection Members

TroughCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

TroughCrossSection Members

TroughCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

TroughCrossSection Members