SC::Store Namespace Reference

Namespaces

 Utils
 

Classes

class  AssemblyTree
 AssemblyTree API. More...
 
class  BaseMesh
 
struct  BBox
 BBox. More...
 
class  Cache
 
class  Camera
 
class  ClipRegionKey
 
class  ClipSubRegion
 The ClipSubRegion class is used to define a ClipRegionKey. More...
 
struct  Color
 
class  Database
 
class  DataKey
 
struct  DPoint
 
struct  DVector
 
struct  EntityFilterItemData
 
class  Exception
 
struct  FilterData
 
struct  Gray8
 
struct  GrayAlpha16
 
class  GroupKey
 
struct  IdHasher
 
class  ImageKey
 
class  InclusionKey
 
class  InstanceKey
 
struct  KeyHasher
 
struct  KeyHasher< uint32_t >
 
struct  LayerData
 
struct  LayerFilterItemData
 
class  Logger
 
class  Material
 The Material class is used to define a MaterialKey. More...
 
struct  MaterialData
 Material information comes from the HOOPS Exchange definition. Please refer to the Exchange documentation to get more information: http://docs.techsoft3d.com/exchange/latest/build/struct_a3_d_graph_material_data.html. More...
 
class  MaterialKey
 
class  MaterialMapElement
 The MaterialMapElement class is used to define a MaterialMapKey with a sparse material map. More...
 
class  MaterialMapKey
 
class  MaterialProperties
 The MaterialProperties class is used to define a Material or specify the defaults for a View. More...
 
struct  Matrix3d
 
class  MatrixKey
 
class  MemoryDevice
 
class  MemoryDeviceFile
 
class  Mesh
 
class  MeshElement
 
class  MeshKey
 
class  Model
 
class  ModelKey
 
class  Modifiers
 
struct  Normal
 
struct  Plane
 Plane. More...
 
struct  Point
 
class  PolyPolygonKey
 
struct  RefOnTopoItem
 Identifies a reference to an element on a brep. More...
 
struct  RGB24
 
struct  RGBA32
 
struct  StyleData
 Style information comes from the HOOPS Exchange definition. Please refer to the Exchange documentation for more information: http://docs.techsoft3d.com/exchange/latest/build/struct_a3_d_graph_style_data.html. More...
 
class  Texture
 The Texture class is used to define a Material. More...
 
struct  UV
 
struct  Vector
 
class  VectorCulling
 The VectorCulling class is used to define vector culling on an instance. More...
 
class  ViewKey
 
class  Visibility
 

Typedefs

typedef std::pair< ModelKey, ClipRegionKeyClipRegionId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< ClipRegionIdClipRegionIds
 A std::vector of ClipRegionId. More...
 
typedef std::vector< ClipRegionKeyClipRegionKeys
 A std::vector of ClipRegionKey. More...
 
typedef std::vector< ClipSubRegionClipSubRegions
 A std::vector of ClipSubRegion. More...
 
typedef std::pair< ModelKey, DataKeyDataId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< DataIdDataIds
 A std::vector of DataId. More...
 
typedef std::vector< DataKeyDataKeys
 A std::vector of DataKey. More...
 
using FileType = uint32_t
 
using GenericTypeKey = uint32_t
 
typedef std::pair< ModelKey, GroupKeyGroupId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< GroupIdGroupIds
 A std::vector of MeshId. More...
 
typedef std::pair< InclusionKey, GroupKeyGroupInc
 This is an instance through a specific include. More...
 
typedef std::vector< GroupIncGroupIncs
 A std::vector of GroupInc. More...
 
typedef std::vector< GroupKeyGroupKeys
 A std::vector of GroupKey. More...
 
typedef std::pair< ModelKey, ImageKeyImageId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< ImageIdImageIds
 A std::vector of ImageId. More...
 
typedef std::vector< ImageKeyImageKeys
 A std::vector of ImageKey. More...
 
typedef std::vector< InclusionKeyInclusionKeys
 A std::vector of InclusionKey. More...
 
typedef std::pair< ModelKey, InstanceKeyInstanceId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< InstanceIdInstanceIds
 A std::vector of InstanceId. More...
 
typedef std::pair< InclusionKey, InstanceKeyInstanceInc
 This is an instance through a specific include. More...
 
typedef std::vector< InstanceIncInstanceIncs
 A std::vector of InstanceInc. More...
 
typedef std::vector< InstanceKeyInstanceKeys
 A std::vector of InstanceKey. More...
 
using LayerId = uint32_t
 
typedef std::pair< ModelKey, MaterialKeyMaterialId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< MaterialIdMaterialIds
 A std::vector of MaterialId. More...
 
typedef std::vector< MaterialKeyMaterialKeys
 A std::vector of MaterialKey. More...
 
typedef std::vector< MaterialMapElementMaterialMapElements
 A std::vector of MaterialMapElement. More...
 
typedef std::pair< ModelKey, MaterialMapKeyMaterialMapId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< MaterialMapIdMaterialMapIds
 A std::vector of MaterialMapId. More...
 
typedef std::vector< MaterialMapKeyMaterialMapKeys
 A std::vector of MaterialMapKey. More...
 
typedef std::pair< ModelKey, MatrixKeyMatrixId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< MatrixIdMatrixIds
 A std::vector of MatrixId. More...
 
typedef std::vector< MatrixKeyMatrixKeys
 A std::vector of MatrixKey. More...
 
typedef std::pair< ModelKey, MeshKeyMeshId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< MeshIdMeshIds
 A std::vector of MeshId. More...
 
typedef std::vector< MeshKeyMeshKeys
 A std::vector of MeshKey. More...
 
using NodeId = uint32_t
 
typedef std::pair< ModelKey, PolyPolygonKeyPolyPolygonId
 This is an ID that is completely unique throughout an entire cache. More...
 
typedef std::vector< PolyPolygonIdPolyPolygonIds
 A std::vector of PolyPolygonId. More...
 
typedef std::vector< PolyPolygonKeyPolyPolygonKeys
 A std::vector of PolyPolygonKey. More...
 
using UserDataIndex = uint64_t
 

Enumerations

enum  BodyType : uint8_t {
  BodyTypeNotSet = 0, BRep = 1, Tessellation = 2, Wireframe = 3,
  PointCloud = 4
}
 
enum  ImageFormat : uint32_t { ImageFormat::PNG, ImageFormat::JPEG, ImageFormat::BMP }
 The ImageFormat enum class is used to define an ImageKey from the byte data of an image file. More...
 
enum  PMISubType : uint32_t {
  SubTypeUnknown = 0, DatumIdent = 1, DatumTarget = 2, DimensionDistance = 1,
  DimensionDistanceOffset = 2, DimensionDistanceCumulate = 3, DimensionChamfer = 4, DimensionSlope = 5,
  DimensionOrdinate = 6, DimensionRadius = 7, DimensionRadiusTangent = 8, DimensionRadiusCylinder = 9,
  DimensionRadiusEdge = 10, DimensionDiameter = 11, DimensionDiameterTangent = 12, DimensionDiameterCylinder = 13,
  DimensionDiameterEdge = 14, DimensionDiameterCone = 15, DimensionLength = 16, DimensionLengthCurvilinear = 17,
  DimensionLengthCircular = 18, DimensionAngle = 19, GdtFcf = 1, WeldingLine = 1,
  WeldingSpot = 2, OtherSymbolUser = 1, OtherSymbolUtility = 2, OtherSymbolCustom = 3,
  OtherGeometricReference = 4, OtherRegion = 5
}
 
enum  PMITopoRef : uint8_t {
  Context = 1, Item = 2, MultipleVertex = 3, UniqueVertex = 4,
  WireEdge = 5, Edge = 6, CoEdge = 7, Loop = 8,
  Face = 9, Shell = 10, Connex = 11, Body = 12,
  SingleWireBody = 13, BrepData = 14, WireBody = 17
}
 
enum  PMIType : uint32_t {
  TypeUnknown = 0, Text = 1, Dimension = 2, Arrow = 3,
  Balloon = 4, CircleCenter = 5, Coordinate = 6, Datum = 7,
  Fastener = 8, Gdt = 9, Locator = 10, MeasurementPoint = 11,
  Roughness = 12, Welding = 13, Table = 14, Other = 15,
  GeometricalTolerance = 16
}
 
enum  SelectionBits : uint8_t { SelectionBitsFaceHasMeasurementData = 1 << 0, SelectionBitsFacePlanar = 1 << 1, SelectionBitsEdgeHasMeasurementData = 1 << 2 }
 

Typedef Documentation

◆ ClipRegionId

This is an ID that is completely unique throughout an entire cache.

◆ ClipRegionIds

typedef std::vector<ClipRegionId> SC::Store::ClipRegionIds

A std::vector of ClipRegionId.

◆ ClipRegionKeys

A std::vector of ClipRegionKey.

◆ ClipSubRegions

A std::vector of ClipSubRegion.

◆ DataId

typedef std::pair<ModelKey, DataKey> SC::Store::DataId

This is an ID that is completely unique throughout an entire cache.

◆ DataIds

typedef std::vector<DataId> SC::Store::DataIds

A std::vector of DataId.

◆ DataKeys

typedef std::vector<DataKey> SC::Store::DataKeys

A std::vector of DataKey.

◆ FileType

using SC::Store::FileType = typedef uint32_t

◆ GenericTypeKey

using SC::Store::GenericTypeKey = typedef uint32_t

GenericTypeKey type

◆ GroupId

typedef std::pair<ModelKey, GroupKey> SC::Store::GroupId

This is an ID that is completely unique throughout an entire cache.

◆ GroupIds

typedef std::vector<GroupId> SC::Store::GroupIds

A std::vector of MeshId.

◆ GroupInc

This is an instance through a specific include.

◆ GroupIncs

typedef std::vector<GroupInc> SC::Store::GroupIncs

A std::vector of GroupInc.

◆ GroupKeys

typedef std::vector<GroupKey> SC::Store::GroupKeys

A std::vector of GroupKey.

◆ ImageId

typedef std::pair<ModelKey, ImageKey> SC::Store::ImageId

This is an ID that is completely unique throughout an entire cache.

◆ ImageIds

typedef std::vector<ImageId> SC::Store::ImageIds

A std::vector of ImageId.

◆ ImageKeys

typedef std::vector<ImageKey> SC::Store::ImageKeys

A std::vector of ImageKey.

◆ InclusionKeys

typedef std::vector<InclusionKey> SC::Store::InclusionKeys

A std::vector of InclusionKey.

◆ InstanceId

This is an ID that is completely unique throughout an entire cache.

◆ InstanceIds

typedef std::vector<InstanceId> SC::Store::InstanceIds

A std::vector of InstanceId.

◆ InstanceInc

This is an instance through a specific include.

◆ InstanceIncs

typedef std::vector<InstanceInc> SC::Store::InstanceIncs

A std::vector of InstanceInc.

◆ InstanceKeys

typedef std::vector<InstanceKey> SC::Store::InstanceKeys

A std::vector of InstanceKey.

◆ LayerId

using SC::Store::LayerId = typedef uint32_t

LayerId type

◆ MaterialId

This is an ID that is completely unique throughout an entire cache.

◆ MaterialIds

typedef std::vector<MaterialId> SC::Store::MaterialIds

A std::vector of MaterialId.

◆ MaterialKeys

typedef std::vector<MaterialKey> SC::Store::MaterialKeys

A std::vector of MaterialKey.

◆ MaterialMapElements

◆ MaterialMapId

This is an ID that is completely unique throughout an entire cache.

◆ MaterialMapIds

A std::vector of MaterialMapId.

◆ MaterialMapKeys

A std::vector of MaterialMapKey.

◆ MatrixId

typedef std::pair<ModelKey, MatrixKey> SC::Store::MatrixId

This is an ID that is completely unique throughout an entire cache.

◆ MatrixIds

typedef std::vector<MatrixId> SC::Store::MatrixIds

A std::vector of MatrixId.

◆ MatrixKeys

typedef std::vector<MatrixKey> SC::Store::MatrixKeys

A std::vector of MatrixKey.

◆ MeshId

typedef std::pair<ModelKey, MeshKey> SC::Store::MeshId

This is an ID that is completely unique throughout an entire cache.

◆ MeshIds

typedef std::vector<MeshId> SC::Store::MeshIds

A std::vector of MeshId.

◆ MeshKeys

typedef std::vector<MeshKey> SC::Store::MeshKeys

A std::vector of MeshKey.

◆ NodeId

using SC::Store::NodeId = typedef uint32_t

NodeId type

◆ PolyPolygonId

This is an ID that is completely unique throughout an entire cache.

◆ PolyPolygonIds

A std::vector of PolyPolygonId.

◆ PolyPolygonKeys

A std::vector of PolyPolygonKey.

◆ UserDataIndex

using SC::Store::UserDataIndex = typedef uint64_t

UserDataIndex type

Enumeration Type Documentation

◆ BodyType

enum SC::Store::BodyType : uint8_t

Body type

Enumerator
BodyTypeNotSet 

Not defined.

BRep 

Body comes from a brep.

Tessellation 

Body comes from a tessellated model.

Wireframe 

Body comes from a wireframed model.

PointCloud 

Body comes from a point cloud.

◆ ImageFormat

enum SC::Store::ImageFormat : uint32_t
strong

The ImageFormat enum class is used to define an ImageKey from the byte data of an image file.

Enumerator
PNG 
JPEG 
BMP 

The 1 bit and RLE formats are not supported.

◆ PMISubType

enum SC::Store::PMISubType : uint32_t

PMI subtype

Enumerator
SubTypeUnknown 
DatumIdent 

Datum subtype.

DatumTarget 

Datum subtype.

DimensionDistance 

Dimension distance subtype.

DimensionDistanceOffset 

Dimension distance subtype.

DimensionDistanceCumulate 

Dimension distance subtype.

DimensionChamfer 

Dimension chamfer subtype.

DimensionSlope 

Dimension slope subtype.

DimensionOrdinate 

Dimension ordinate subtype.

DimensionRadius 

Dimension radius subtype.

DimensionRadiusTangent 

Dimension radius subtype.

DimensionRadiusCylinder 

Dimension radius subtype.

DimensionRadiusEdge 

Dimension radius subtype.

DimensionDiameter 

Dimension diameter subtype.

DimensionDiameterTangent 

Dimension diameter subtype.

DimensionDiameterCylinder 

Dimension diameter subtype.

DimensionDiameterEdge 

Dimension diameter subtype.

DimensionDiameterCone 

Dimension diameter subtype.

DimensionLength 

Dimension length subtype.

DimensionLengthCurvilinear 

Dimension length subtype.

DimensionLengthCircular 

Dimension length subtype.

DimensionAngle 

Dimension angle subtype.

GdtFcf 

GD&T Feature control frame subtype.

WeldingLine 

Line welding subtype.

WeldingSpot 

Spot welding subtype.

OtherSymbolUser 

User symbol, other subtype.

OtherSymbolUtility 

Utility symbol, other subtype.

OtherSymbolCustom 

Custom symbol, other subtype.

OtherGeometricReference 

Geometric reference, other subtype.

OtherRegion 

Region symbol, other subtype.

◆ PMITopoRef

enum SC::Store::PMITopoRef : uint8_t

PMI reference to topology (brep)

Enumerator
Context 

Self-containing set of topological entities.

Item 

Abstract root type for any topological entity (body or single item)

MultipleVertex 

Vertex whose position is the average of all edges' extremity positions to whom it belongs.

UniqueVertex 

Vertex with one set of coordinates (absolute position)

WireEdge 

Edge belonging to a wire body.

Edge 

Edge belonging to a BrepData body.

CoEdge 

Usage of an edge in a loop.

Loop 

Array of co-edges that delimit a face.

Face 

Topological face delimiting a shell.

Shell 

Topological shell (open or closed)

Connex 

Topological region.

Body 

Abstract root type for any topological body.

SingleWireBody 

Single wire body.

BrepData 

Main entry to non-wire topology.

WireBody 

Main entry to wire topology.

◆ PMIType

enum SC::Store::PMIType : uint32_t

PMI type

Enumerator
TypeUnknown 

Unknown value.

Text 

Plain text.

Dimension 

Dimension.

Arrow 

Arrow.

Balloon 

Balloon.

CircleCenter 

Center of circle.

Coordinate 

Coordinate.

Datum 

Datum.

Fastener 

Fastener.

Gdt 

GD&T.

Locator 

Locator.

MeasurementPoint 

Point.

Roughness 

Roughness.

Welding 

Welding.

Table 

Table.

Other 

Other.

GeometricalTolerance 

Geometrical tolerance.

◆ SelectionBits

enum SC::Store::SelectionBits : uint8_t

Bits assignable to Mesh's face_elements_bits / polyline_elements_bits / point_elements_bits

Enumerator
SelectionBitsFaceHasMeasurementData 
SelectionBitsFacePlanar 
SelectionBitsEdgeHasMeasurementData