Geometry

Types for working with geometry.

Classes

Name Description  
BoundingSphere Represents a bounding sphere.  
Cartographic A position on the earth defined by longitude, latitude, and height above the WGS84 ellipsoid.  
CartographicRange A cartographic range representing a rectangular region if low longitude/latitude > high then area crossing seam is indicated.  
GeometryStreamBuilder GeometryStreamBuilder is a helper class for populating the GeometryStreamProps array needed to create a GeometricElement or GeometryPart.  
GeometryStreamIterator GeometryStreamIterator is a helper class for iterating a GeometryStreamProps.  
ImageGraphic A geometric primitive that displays an image mapped to the corners of a quadrilateral, with an optional border.  
ImageGraphicCorners Defines the 4 corners of an ImageGraphic.  
Placement2d The placement of a GeometricElement2d.  
Placement3d The placement of a GeometricElement3d.  
QParams2d Parameters used for QParams2d.Quantization of 2d points such that the x and y components are each quantized to 16-bit unsigned integers.  
QParams3d Parameters used for QParams3d.Quantization of 3d points such that the x, y, and z components are each quantized to 16-bit unsigned integers.  
QPoint2d Represents a Point2d compressed such that each component x and y is quantized to the 16-bit integer range [0, 0xffff].  
QPoint2dList A list of QPoint2ds all quantized to the same range.  
QPoint3d Represents a Point3d compressed such that each component x, y, and z is quantized to the 16-bit integer range [0, 0xffff].  
QPoint3dList A list of QPoint3ds all quantized to the same range.  
TextString A single line of text, all with the same font, styles (underline, bold, italic), and size.  

Enumerations

Name Description  
GeometryStreamFlags Flags applied to the entire contents of a GeometryStreamProps.  
GeometrySummaryVerbosity Describes the level of detail with which to report each geometric primitive in a GeometrySummaryRequestProps.  
MassPropertiesOperation Specify whether to accumulate volumes, areas, or lengths for the supplied elements.  

Interfaces

Name Description  
AreaFillProps Add a AreaFillProps.gradient, AreaFillProps.backgroundFill, or solid AreaFillProps.color fill to subsequent planar regions (or meshes).  
BRepPrimitive Represents a BRep within a GeometryStream.  
DeletedElementGeometryChange Represents the deletion of a GeometricElement.  
ElementIdsAndRangesProps Compact wire format representing geometric changes to a set of elements as part of a ModelGeometryChangesProps.  
ExtantElementGeometryChange Represents the insertion of a new GeometricElement, or a change to the geometric properties of an existing GeometricElement.  
GeometryAppearanceProps Establish a non-default SubCategory or to override SubCategoryAppearance for the geometry that follows.  
GeometryContainmentRequestProps Information required to request clip containment status for elements from the front end to the back end.  
GeometryContainmentResponseProps Information returned from the back end to the front end holding the result of the geometry containment query.  
GeometryPartInstanceProps Add a reference to a GeometryPart from the GeometryStream of a GeometricElement.  
GeometryPrimitive Represents one of a variety of GeometryQuery objects within a GeometryStream.  
GeometryStreamEntryProps Allowed GeometryStream entries - should only set one value.  
GeometryStreamHeaderProps An entry in a GeometryStreamProps containing GeometryStreamFlags that apply to the geometry stream as a whole.  
GeometryStreamIteratorEntry Holds current state information for GeometryStreamIterator.  
GeometrySummaryOptions Describes what information to include in a GeometrySummaryRequestProps.  
GeometrySummaryRequestProps Describes the elements for which to generate an array of geometry summaries and the options controlling the contents of each summary.  
ImageGraphicProps JSON representation of an ImageGraphic.  
ImagePrimitive Represents an image within a GeometryStream.  
LatAndLong  
LatLongAndHeight  
MassPropertiesRequestProps Information required to request mass properties for elements from the front end to the back end.  
MassPropertiesResponseProps Information returned from the back end to the front end holding the result of the mass properties calculation.  
MaterialProps Override SubCategoryAppearance.materialId for subsequent surface and solid geometry.  
ModelGeometryChangesProps Compact wire format representing geometric changes to GeometricElements within a GeometricModel.  
PartReference Represents a reference to a GeometryPart within a GeometryStream.  
TextStringPrimitive Represents a text string within a GeometryStream.  
TextStringProps Properties for a TextString class.  

Namespaces

Name Description  
BRepEntity JSON representation of a brep GeometryStream entry.  
ElementGeometry Provides utility functions for working with ElementGeometryDataEntry.  
ElementGeometryChange Represents a change to the geometry of a GeometricElement, as exposed by ModelGeometryChanges.elements.  
ModelGeometryChanges Represents geometric changes to a set of GeometricElements belonging to a single GeometricModel.  
Quantization Provides facilities for quantizing floating point values within a specified range into 16-bit unsigned integers.  

Type Aliases

Name Description  
AxisAlignedBox3d A Range3d that is aligned with the axes of spatial coordinates.  
AxisAlignedBox3dProps The properties of a Range3d.  
ElementAlignedBox2d A bounding box aligned to the orientation of a 2d Element  
ElementAlignedBox3d A bounding box aligned to the orientation of a 3d Element  
GeometryStreamPrimitive Union of all possible geometric primitive types that may appear within a GeometryStream.  
GeometryStreamProps A GeometricElement's GeometryStream is represented by an array of GeometryStreamEntryProps.  
ImageGraphicCornersProps JSON representation of the 4 corners of an ImageGraphicProps.  
LocalAlignedBox3d A bounding box aligned to a local coordinate system  
Placement Either a Placement2d or Placement3d  

Last Updated: 19 April, 2021