CustomCrossSection Class

Custom corridor 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 CustomCrossSection : CrossSection

Remarks

CustomCrossSection allows the user to use a custom point collection assigned to the outline property. The point coordinates in the outline are interpreted as meters.

One drawback of the custom cross section is that its size and shape cannot be controlled by input line feature attributes, as is possible with the other types of cross section.

The outline shall go clockwise around the corridor, using the X coordinate for horizontal and Y for vertical positioning, with the origin where the cross section intersects the input line of the CorridorOperator3D. The Z coordinate is not used. The last point in the outline must be the same as the first point for the corridor to be closed. An example of a custom cross section starting and ending in the top point is shown below:

The black dot indicates the origin of the X/Y coordinate system, and the outline points are shown in red.

Texturization

A corridor mesh created from a CustomCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 the first point in the outline, increasing along the outline ending at 1 on the last point. 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
        CustomCrossSection

Platforms

Windows, Linux, Android

CustomCrossSection Members

The CustomCrossSection type has the following members.

Constructors

Name	Description
CustomCrossSection	The outline used by this cross section.

Properties

Name	Description
IsDisposed	Gets a value that tells whether the current CustomCrossSection has been disposed. Inherited from EngineObject
Name	Gets or sets the name of the CustomCrossSection. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current CustomCrossSection represents. Inherited from EngineObject
Outline	Gets or sets the outline points for this cross section.
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

CustomCrossSection Class

Custom corridor 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 CustomCrossSection : public CrossSection

C++ Smart Pointer Declaration

typedef Ptr<CustomCrossSection> CustomCrossSectionPtr;

Remarks

CustomCrossSection allows the user to use a custom point collection assigned to the outline property. The point coordinates in the outline are interpreted as meters.

One drawback of the custom cross section is that its size and shape cannot be controlled by input line feature attributes, as is possible with the other types of cross section.

The black dot indicates the origin of the X/Y coordinate system, and the outline points are shown in red.

Texturization

A corridor mesh created from a CustomCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 the first point in the outline, increasing along the outline ending at 1 on the last point. 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
      CustomCrossSection

Platforms

Windows, Linux, Android

CustomCrossSection Members

The CustomCrossSection type has the following members.

Constructors

Name	Description
CustomCrossSection	The outline used by this cross section.

Properties

Name	Description
name	Gets or sets the name of the CustomCrossSection. Inherited from ResourceObject
outline	Gets or sets the outline points for this cross section.
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

CustomCrossSection Class

Custom corridor 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 CustomCrossSection extends CrossSection

Remarks

CustomCrossSection allows the user to use a custom point collection assigned to the outline property. The point coordinates in the outline are interpreted as meters.

One drawback of the custom cross section is that its size and shape cannot be controlled by input line feature attributes, as is possible with the other types of cross section.

The black dot indicates the origin of the X/Y coordinate system, and the outline points are shown in red.

Texturization

A corridor mesh created from a CustomCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 the first point in the outline, increasing along the outline ending at 1 on the last point. 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
        CustomCrossSection

Platforms

Windows, Linux, Android

CustomCrossSection Members

The CustomCrossSection type has the following members.

Constructors

Name	Description
CustomCrossSection	The outline used by this cross section.

Properties

Name	Description
isDisposed	Gets a value that tells whether the current CustomCrossSection has been disposed. Inherited from EngineObject
name	Gets or sets the name of the CustomCrossSection. Inherited from ResourceObject
outline	Gets or sets the outline points for this cross section.
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

CustomCrossSection Class

Custom corridor 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 CustomCrossSection ( CrossSection )

Remarks

CustomCrossSection allows the user to use a custom point collection assigned to the outline property. The point coordinates in the outline are interpreted as meters.

One drawback of the custom cross section is that its size and shape cannot be controlled by input line feature attributes, as is possible with the other types of cross section.

The black dot indicates the origin of the X/Y coordinate system, and the outline points are shown in red.

Texturization

A corridor mesh created from a CustomCrossSection can be textured with a Material attached to a MeshVisualizer. The texture U parameter is mapped from 0 the first point in the outline, increasing along the outline ending at 1 on the last point. 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
      CustomCrossSection

Platforms

Windows, Linux, Android

CustomCrossSection Members

The CustomCrossSection type has the following members.

Constructors

Name	Description
CustomCrossSection	The outline used by this cross section.

Properties

Name	Description
name	Gets or sets the name of the CustomCrossSection. Inherited from ResourceObject
outline	Gets or sets the outline points for this cross section.
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

CustomCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CustomCrossSection Members

CustomCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CustomCrossSection Members

CustomCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CustomCrossSection Members

CustomCrossSection Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

CustomCrossSection Members