API Reference > geometry-core > Solid > SolidPrimitive

SolidPrimitive Class

Base class for SolidPrimitive variants.

  • The base class holds capped flag for all derived classes.

Extends

Extended by

Methods

Name Description
constructor(capped: boolean): SolidPrimitive Protected    
constantVSection(_vFraction: number): CurveCollection | undefined Abstract Return a cross section at specified vFraction.  
getConstructiveFrame(): Transform | undefined Abstract Return a Transform from the local system of the solid to world.  

Inherited methods

Name Inherited from Description
clone(): GeometryQuery | undefined Abstract GeometryQuery return a clone
cloneTransformed(transform: Transform): GeometryQuery | undefined Abstract GeometryQuery return a transformed clone.
dispatchToGeometryHandler(handler: GeometryHandler): any Abstract GeometryQuery * "double dispatch" call pattern.
extendRange(rangeToExtend: Range3d, transform?: Transform): void Abstract GeometryQuery extend rangeToExtend by the range of this geometry multiplied by the transform
isAlmostEqual(other: GeometryQuery): boolean GeometryQuery test for exact structure and nearly identical geometry.
isSameGeometryClass(other: GeometryQuery): boolean Abstract GeometryQuery test if (other instanceof this.Type).
range(transform?: Transform, result?: Range3d): Range3d GeometryQuery return the range of the entire (tree) GeometryQuery
tryTransformInPlace(transform: Transform): boolean Abstract GeometryQuery Attempt to transform in place.
tryTranslateInPlace(dx: number, dy: number = 0, dz: number = 0): boolean GeometryQuery try to move the geometry by dx,dy,dz

Properties

Name Type Description
_capped Protected boolean flag indicating whether cap region is considered closed (i.e.  
capped Accessor boolean Ask if this is a capped solid  
geometryCategory "solid" = "solid" String name for schema properties  
isClosedVolume Accessor ReadOnly boolean    
solidPrimitiveType Abstract SolidPrimitiveType String name for schema properties  

Inherited properties

Name Type Inherited from Description
children Accessor ReadOnly GeometryQuery[] | undefined GeometryQuery return GeometryQuery children for recursive queries.

* leaf classes do not need to implement.

Defined in

Last Updated: 08 January, 2020