RectangleCrossSection Class

A rectangle 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

public class RectangleCrossSection : CrossSection

Remarks

A corridor cross section in with the shape of a rectangle with properties width and height defining its shape in meters. The shape is illustrated in the image below:

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

Texturization

A corridor mesh created from a RectangleCrossSection 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
        RectangleCrossSection

Platforms

Windows, Linux, Android

RectangleCrossSection Members

The RectangleCrossSection type has the following members.

Constructors

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

Properties

Name	Description
Height	Gets or sets the height of this rectangle cross section, in meters.
IsDisposed	Gets a value that tells whether the current RectangleCrossSection has been disposed. Inherited from EngineObject
Name	Gets or sets the name of the RectangleCrossSection. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current RectangleCrossSection represents. Inherited from EngineObject
IUserProperties.UserProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
Width	Gets or sets the width of this rectangle cross section, in meters.

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

RectangleCrossSection Class

A rectangle cross section used 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 RectangleCrossSection : public CrossSection

C++ Smart Pointer Declaration

typedef Ptr<RectangleCrossSection> RectangleCrossSectionPtr;

Remarks

A corridor cross section in with the shape of a rectangle with properties width and height defining its shape in meters. The shape is illustrated in the image below:

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

Texturization

A corridor mesh created from a RectangleCrossSection 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
      RectangleCrossSection

Platforms

Windows, Linux, Android

RectangleCrossSection Members

The RectangleCrossSection type has the following members.

Constructors

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

Properties

Name	Description
height	Gets or sets the height of this rectangle cross section, in meters.
name	Gets or sets the name of the RectangleCrossSection. Inherited from ResourceObject
IUserProperties::userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
width	Gets or sets the width of this rectangle cross section, in meters.

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

RectangleCrossSection Class

A rectangle 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 RectangleCrossSection extends CrossSection

Remarks

A corridor cross section in with the shape of a rectangle with properties width and height defining its shape in meters. The shape is illustrated in the image below:

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

Texturization

A corridor mesh created from a RectangleCrossSection 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
        RectangleCrossSection

Platforms

Windows, Linux, Android

RectangleCrossSection Members

The RectangleCrossSection type has the following members.

Constructors

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

Properties

Name	Description
height	Gets or sets the height of this rectangle cross section, in meters.
isDisposed	Gets a value that tells whether the current RectangleCrossSection has been disposed. Inherited from EngineObject
name	Gets or sets the name of the RectangleCrossSection. Inherited from ResourceObject
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
width	Gets or sets the width of this rectangle cross section, in meters.

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

RectangleCrossSection Class

A rectangle 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 RectangleCrossSection ( CrossSection )

Remarks

A corridor cross section in with the shape of a rectangle with properties width and height defining its shape in meters. The shape is illustrated in the image below:

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

Texturization

A corridor mesh created from a RectangleCrossSection 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
      RectangleCrossSection

Platforms

Windows, Linux, Android

RectangleCrossSection Members

The RectangleCrossSection type has the following members.

Constructors

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

Properties

Name	Description
height	Gets or sets the height of this rectangle cross section, in meters.
name	Gets or sets the name of the RectangleCrossSection. Inherited from ResourceObject
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
width	Gets or sets the width of this rectangle cross section, in meters.

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

RectangleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

RectangleCrossSection Members

RectangleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

RectangleCrossSection Members

RectangleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

RectangleCrossSection Members

RectangleCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

RectangleCrossSection Members