ArcGIS Procedural Runtime  3.2.10650
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
prtx::TrimPlane Class Reference

#include <TrimPlane.h>

Public Member Functions

MeshPtr getMesh () const
 
const DoubleVectorgetOrigEdgeCoords () const
 
bool isHorizontal () const
 
bool isLimited () const
 
bool isVertical () const
 
TrimPlaneoperator= (const TrimPlane &)=delete
 
 TrimPlane (const TrimPlane &)=delete
 

Protected Member Functions

 TrimPlane (Payload *payload)
 

Protected Attributes

Payload * mPayload
 

Detailed Description

Provides read-only access to the trim planes generated during CGA generate(). Trim planes are in the Shape's pivot coordinate system.

See also
ShapeUtils::getPivotToWorldTrafo()

Member Function Documentation

◆ getMesh()

MeshPtr prtx::TrimPlane::getMesh ( ) const

Note that the size of the plane depends on the "/cgaenv/trimPlanesComputeSize" setting, see prt::InitialShapeBuilder::setAttributes().

Returns
the plane which was constructed during generate(), in pivot coordinates.

◆ getOrigEdgeCoords()

const DoubleVector& prtx::TrimPlane::getOrigEdgeCoords ( ) const
Returns
the original edge in pivot coordinates: [startx, starty, startz, endx, endy, endz]

◆ isHorizontal()

bool prtx::TrimPlane::isHorizontal ( ) const

See the trim shape attribute in the CGA ref.

Returns
true if the orientation of the TrimPlane is horizontal.

◆ isLimited()

bool prtx::TrimPlane::isLimited ( ) const

Trim planes can be limited or unlimited. A trim plane is limited on the side where the end point of the original edge is a concave polygon vertex. @ returns true if the TrimPlane is limited on one or both sides.

◆ isVertical()

bool prtx::TrimPlane::isVertical ( ) const

See the trim shape attribute in the CGA ref.

Returns
true if the orientation of the TrimPlane is vertical.

The documentation for this class was generated from the following file: