API Types

struct activePointResult

#include <CwAPI3DTypes.h>

Result of an active point query.

Public Members

bool mHasPoint

vector3D mPoint

struct bimTeamUploadResult

#include <CwAPI3DTypes.h>

Result object of a BIMteam upload operation.

Public Members

bimTeamUploadResultCode mUploadResultCode: Result code from a BIMteam upload operation.

narrowString mShareLink: Link to the uploaded file. Is empty when mUploadResultCode is not Ok.

struct colorRGB

#include <CwAPI3DTypes.h>

RGB Color.

Public Members

uint32_t mR: Red Value.

uint32_t mG: Green Value.

uint32_t mB: Blue Value.

struct point

#include <CwAPI3DTypes.h>

Public Members

int mX = {0}: x coordinate of this point

int mY = {0}: y coordinate of this point

struct vector3D

#include <CwAPI3DTypes.h>

3D vector

Public Members

double mX: X Coordinate.

double mY: Y Coordinate.

double mZ: Z Coordinate.

struct windowGeometry

#include <CwAPI3DTypes.h>

Holds the geometry of the 3d main window.

Public Members

point mBottomLeft: position of the rectangle’s bottom-left corner

point mBottomRight: position of the rectangle’s bottom-right corner

point mTopLeft: position of the rectangle’s top-left corner

point mTopRight: position of the rectangle’s top-right corner

namespace CwAPI3D

Typedefs

using elementID = uint64_t

using materialID = uint64_t

using colorID = uint32_t

using endtypeID = uint64_t

using axisID = uint64_t

using menuIndex = int32_t

using referenceSide = uint32_t

using multiLayerSetID = uint64_t

using character = wchar_t

using narrowCharacter = char

using wideCharacter = wchar_t

using string = std::wstring

using narrowString = std::string

using wideString = std::wstring

Enums

enum divisionZoneDirection

Direction of a division zone.

Values:

enumerator positive

enumerator negative

enumerator none

enum nodeSymbol

Hoops node symbol.

Values:

enumerator SmallSquare

enumerator Square

enumerator Cross

enumerator Circle

enumerator FilledCircle

enumerator ChessSquare

enumerator HalfFilledSquare

enumerator CrossSquare

enumerator FilledSquare

enum elementModuleDetail

Element modul detail.

Values:

enumerator NoDetail

enumerator AngleDetail

enumerator AreaDetail

enumerator CrossDetail

enumerator EdgeDetail

enumerator EndDetail

enumerator LineDetail

enumerator OpenDetail

enumerator TDetail

enumerator FloorAreaDetail

enumerator FloorEndDetail

enumerator FloorLineDetail

enumerator FloorOpenDetail

enum shortcutKey

Shortcut key.

Values:

enumerator F1

enumerator F2

enumerator F3

enumerator F4

enumerator F5

enumerator F6

enumerator F7

enumerator F8

enumerator F9

enumerator F10

enumerator F11

enumerator F12

enum shortcutKeyModifier

Shortcut key modifier.

Values:

enumerator None

enumerator Shift

enumerator Control

enumerator Alt

enum btlVersion

BTL file version.

Values:

enumerator btl_1_0

enumerator btl_1_1

enumerator btl_1_2

enumerator btl_1_3

enumerator btl_1_4

enumerator btl_1_5

enumerator btl_1_6

enumerator btl_10_0

enumerator btl_10_1

enumerator btl_10_2

enumerator btl_10_3

enumerator btl_10_4

enumerator btl_10_5

enumerator btl_10_6

enumerator btlx_1_0

enumerator btlx_1_1

enumerator btlx_2_0

enumerator btlx_2_1

enumerator btlx_2_2

enum hundeggerMachineType

Hundegger machine type.

Values:

enumerator p8_10

enumerator k1

enumerator k2

enumerator k2_cambium

enumerator k2_uf_5

enumerator k2_uf_5_cambium

enumerator speedcut

enumerator pba

enumerator pba_bvx

enumerator pba_bvx_cambium

enumerator spm

enumerator spm_cambium

enumerator robot_drive

enumerator turbo_drive

enum weinmannMfbVersion

Weinmann MFB version.

Values:

enumerator wup_2_0

enumerator wup_3_1

enumerator wup_3_2

enumerator wup_3_3

enumerator wup_3_4

enum elementGroupingType

Element grouping type.

Values:

enumerator group

enumerator subgroup

enumerator _none

enum ifcElementCombineBehaviour

IFC element combine behaviour.

Values:

enumerator element_module

enumerator element_assembly

enum ifcMaterialDefinition

IFC material definition.

Values:

enumerator material_layer_set

enumerator material_constituent_set

enumerator ignore

enum textElementType

Text element type.

Values:

enumerator line

enumerator surface

enumerator volume

enumerator raster

enum multiLayerType

Multilayer type.

Values:

enumerator Undefined

enumerator Structure

enumerator Panel

enumerator Lathing

enumerator Air

enumerator Covering

enum standardElementType

Standard element type.

Values:

enumerator beam

enumerator panel

enumerator vba

enumerator exportSolid

enumerator container

enumerator metal

enum bimTeamUploadResultCode

Result code of a BIMteam upload operation.

Values:

enumerator Ok

enumerator ErrorGeneralError

enumerator ErrorTooManyModels

enumerator ErrorInsufficientStorage

enumerator ErrorInvalidProjectId

enumerator ErrorAuthenticationFailed

enum ShoulderDrillingOrientation

Shoulder drilling orientation.

Values:

enumerator DrillingPerpendicularToBisector

enumerator DrillingPerpendicularToCounterPart

enumerator DrillingPerpendicularToStrut

enumerator DrillingPerpendicularToContactSurface

enum ShoulderBeamGeometry

Shoulder beam geometry.

Values:

enumerator Bisector: Bisector.

enumerator Birdsmouth: PerpBirdmouth.

enumerator PerpendicularToStrut: PerpShoulder.

enumerator PerpendicularToCounterPart: PerpChord.

enum HeelShoulderBeamGeometry

Heel shoulder beam geometry.

Values:

enumerator Normal: NormalHeel.

enumerator Straight: StraightHeel.

enum class DimensionBaseFormat : int32_t

Format of how values are displayed for Dimensions.

Values:

enumerator None: Invalid Dimension Format.

enumerator DistanceOnly: Displays only the distance.

enumerator SumOnly: Displays only the summed distances.

enumerator DistanceAndSum: Displays both the distance and the sums.

enumerator SumMoved: Displays the sums with a moved position to prevent overlaps.

enum class DxfLayerFormatType : int32_t

The Formats of how to organize layers.

Values:

enumerator AllInNo1: Put everything in LAYER_NO1.

enumerator Color: Organize layers by color.

enumerator Material: Organize layers by material.

enumerator Name: Organize layers by name.

enumerator Group: Organize layers by group.

enumerator Subgroup: Organize layers by subgroup.

enum class DxfExportVersion : int32_t

The DXF versions supported by the export.

Values:

enumerator AutoCadR10

enumerator AutoCadR27

enum class vbaCatalogItemType : uint64_t

Types of the elements in the VBA Catalog.

Values:

enumerator Null

enumerator Nut: Nuts.

enumerator Washer: Washers.

enumerator SpecialRing: Special type dowels: Bulldog, Rigling.

enumerator SquareWasher: Rectangular washers.

enumerator WoodenPlug: Wood plugs.

enumerator BoltWithHead: Bolts: basic element with head (like construction screws, etc.)

enumerator BoltWithoutHead: Bolts: basic element without head (like threaded rods, etc.)

enumerator LagBolt: Non-through bolts: like coach screws, etc.

enumerator BoltPeg: Bolts: dowel rods (length must be calculated differently for these — always about 2 mm shorter than the clamping length!) → different length automation.

enumerator NormalScrew: Standard screw.

enumerator WoodenDowl: Wood dowel.

enumerator BoltAnchor: Bolt anchor (chemical anchor)

enumerator BoltWithMushroomHead: Carriage bolt / mushroom head.

enumerator BoltWithConicalHead: Countersunk screw / conical head.

enumerator BoltWithHeadAndWasher: Bolt with head and washer.

enumerator HangerBolt: Hanger bolt (double-ended screw)

enumerator ConnectionScrew: Connection screw.

namespace multiLayer

Enums

enum class multiLayerCoverType : uint8_t

Values:

enumerator FramedWall

enumerator SolidWall

enumerator LogWall

enumerator FramedRoof

enumerator SolidRoof

enumerator FramedFloor

enumerator SolidFloor

namespace multiLayerComponentType

Enums

enum multiLayerComponentType

Multilayer component type.

Values:

enumerator Undefined

enumerator Material

enumerator StandardElement

namespace multiLayerSubType

Enums

enum multiLayerSubType

Multilayer subtype.

Values:

enumerator Undefined

enumerator LoadBearingFrameStructure

enumerator SolidStructure

enumerator StraightEdge

enumerator BiasEdge

enumerator Vertical

enumerator Horizontal

enumerator Air

enumerator NonLoadBearingFrameStructure

file CwAPI3DTypes.h: #include <stdint.h>

#include <string>

dir include/cwapi3d

dir include