IModelJson Namespace

ImodelJson namespace has classes for serializing and deserialization json objects

Class

Name Description
IModelJson.Reader parser services for "iModelJson" schema
1: create a reader with new ImodelJsonReader
2: parse json fragment to strongly typed geometry: const g = reader.parse (fragment)
IModelJson.Writer Class to deserialize json objects into GeometryQuery objects

Interface

Name Description
IModelJson.ArcByVectorProps Interface for Arc3d value defined by center, vectorX, vectorY and sweepStartEnd.
IModelJson.AxesProps There are multiple ways to specify an orientation
A "Best" among these is application specific.
IModelJson.BSplineSurfaceProps Property rules for json objects that can be deserialized to a BsplineSurface
See BCurveProps for discussion of knot and pole counts.
IModelJson.BcurveProps Interface for bspline curve (aka bcurve)
IModelJson.BoxProps Interface for Box (or frustum with all rectangular sections parallel to primary xy section)
Orientation may be given in any AxesProps way (yawPitchRoll, xyVectors, zxVectors)
if topX or topY are omitted, each defaults to its baseX or baseY peer.
IModelJson.ConeProps Interface for Cone value defined by centers, radii, and (optional) vectors for circular section planes.
IModelJson.CurveCollectionProps Interface for a collection of curves, eg.
IModelJson.CurvePrimitiveProps Property rules for json objects that can be deserialized to various CurvePrimitives
* Only one of these is allowed in each instance.
IModelJson.CylinderProps Interface for cylinder defined by a radius and axis start and end centers.
IModelJson.GeometryProps Property rules for json objects that can be deserialized to various Curve and Solid objects
IModelJson.IndexedMeshProps Interface for an indexed mesh.
IModelJson.LinearSweepProps Interface for a linear sweep of a base curve or region.
IModelJson.PlanarRegionProps Interface for a collection of curves that bound a planar region
IModelJson.PointProps Property rules for json objects that can be deserialized to single point
IModelJson.RotationalSweepProps Interface for a rotational sweep of a base curve or region around an axis.
IModelJson.RuledSweepProps Interface for a surface with ruled sweeps between corresponding curves on successive contours
Interface for a ruled sweep.
IModelJson.SolidPrimitiveProps Interface for solid primitives: box, sphere, cylinder, cone, torusPipe, linear sweep, rotational sweep, ruled sweep.
IModelJson.SphereProps Interface for Sphere (with optionally different radius to pole versus equator)
* Orientation may be given in any AxesProps way (yawPitchRoll, xyVectors, zxVectors)
IModelJson.TorusPipeProps Interface for TorusPipe data
Orientation may be given in any AxesProps way (yawPitchRoll, xyVectors, zxVectors)
Both radii are required.
IModelJson.TransitionSpiralProps Interface for spiral
* Any 4 (but not 5) of the 5 values [startBearing, endBearing, startRadius, endRadius, length]
may be defined.

Defined in

Last Updated: 08 January, 2020