Link Search Menu Expand Document
OCCTSwift

Document. XCAF Notes, Views & Materials

This page covers the XCAF annotation, view, material, and utility subsystems exposed on Document, AssemblyNode, and several standalone types in Document.swift. For the core document lifecycle, shape tools, and STEP/IGES I/O see the main Document page.

Topics

XCAFDoc_NotesTool

Annotations (notes) attached to assembly labels via XCAFDoc_NotesTool. Notes may be comments, balloons, or opaque binary data blobs.

notesToolNoteCount

Total number of notes in the document.

public var notesToolNoteCount: Int32 { get }
  • OCCT: XCAFDoc_NotesTool::NbNotes
  • Example: 
    let count = document.notesToolNoteCount

notesToolCreateComment(userName:timeStamp:comment:)

Create a plain-text comment note and attach it to the notes tool.

public func notesToolCreateComment(userName: String, timeStamp: String, comment: String) -> AssemblyNode?
  • Parameters: userName, author identifier; timeStamp, ISO-8601 string; comment, note text.
  • Returns: The label node for the new note, or nil if the notes tool could not be found.
  • OCCT: XCAFDoc_NotesTool::CreateComment
  • Example: 
    if let node = document.notesToolCreateComment(
    userName: "alice", timeStamp: "2026-01-01T00:00:00Z", comment: "Check radius") {
    // node.labelId identifies the note label
}

notesToolCreateBalloon(userName:timeStamp:comment:)

Create a balloon (callout) note.

public func notesToolCreateBalloon(userName: String, timeStamp: String, comment: String) -> AssemblyNode?
  • Parameters: userName, author identifier; timeStamp, ISO-8601 string; comment, balloon text.
  • Returns: The label node for the new note, or nil on failure.
  • OCCT: XCAFDoc_NotesTool::CreateBalloon
  • Example: 
    if let node = document.notesToolCreateBalloon(
    userName: "bob", timeStamp: "2026-06-01T12:00:00Z", comment: "Datum A") { }

notesToolCreateBinData(userName:timeStamp:title:mimeType:data:)

Create a binary data note (e.g. an embedded image or PDF attachment).

public func notesToolCreateBinData(
    userName: String,
    timeStamp: String,
    title: String,
    mimeType: String,
    data: [UInt8]
) -> AssemblyNode?
  • Parameters: userName, author; timeStamp, ISO-8601 string; title, display name; mimeType, MIME type string (e.g. "image/png"); data, raw byte payload.
  • Returns: The label node, or nil on failure.
  • OCCT: XCAFDoc_NotesTool::CreateBinData
  • Example: 
    let bytes: [UInt8] = Array(pngData)
if let node = document.notesToolCreateBinData(
    userName: "ci", timeStamp: "2026-06-01T00:00:00Z",
    title: "thumbnail", mimeType: "image/png", data: bytes) { }

notesToolDeleteNote(_:)

Delete a single note identified by its label node.

@discardableResult
public func notesToolDeleteNote(_ node: AssemblyNode) -> Bool
  • Parameters: node, the label node previously returned by a notesToolCreate* call.
  • Returns: true if the note was found and deleted.
  • OCCT: XCAFDoc_NotesTool::DeleteNote
  • Example: 
    if let node = document.notesToolCreateComment(userName: "x", timeStamp: "t", comment: "tmp") {
    document.notesToolDeleteNote(node)
}

notesToolDeleteAllNotes()

Delete every note in the document.

@discardableResult
public func notesToolDeleteAllNotes() -> Int32
  • Returns: Number of notes deleted.
  • OCCT: XCAFDoc_NotesTool::DeleteAllNotes
  • Example: 
    let removed = document.notesToolDeleteAllNotes()

notesToolOrphanNoteCount

Number of orphan notes (notes whose referenced labels no longer exist).

public var notesToolOrphanNoteCount: Int32 { get }
  • OCCT: XCAFDoc_NotesTool::NbOrphanNotes
  • Example: 
    if document.notesToolOrphanNoteCount > 0 {
    document.notesToolDeleteOrphanNotes()
}

notesToolDeleteOrphanNotes()

Delete all orphan notes.

@discardableResult
public func notesToolDeleteOrphanNotes() -> Int32
  • Returns: Number of orphan notes deleted.
  • OCCT: XCAFDoc_NotesTool::DeleteOrphanNotes
  • Example: 
    let pruned = document.notesToolDeleteOrphanNotes()

XCAFDoc_ClippingPlaneTool

Named, storable clipping planes attached to the XCAF document.

clippingPlaneToolAdd(originX:originY:originZ:normalX:normalY:normalZ:name:capping:)

Add a named clipping plane defined by an origin point and a normal direction.

public func clippingPlaneToolAdd(
    originX: Double, originY: Double, originZ: Double,
    normalX: Double, normalY: Double, normalZ: Double,
    name: String,
    capping: Bool
) -> AssemblyNode?
  • Parameters: originX/Y/Z, plane origin; normalX/Y/Z, plane normal (need not be unit-length); name, display name; capping, whether the open cross-section is capped.
  • Returns: Label node for the new clipping plane entry, or nil on failure.
  • OCCT: XCAFDoc_ClippingPlaneTool::AddClippingPlane
  • Example: 
    if let node = document.clippingPlaneToolAdd(
    originX: 0, originY: 0, originZ: 5,
    normalX: 0, normalY: 0, normalZ: 1,
    name: "Z-cut", capping: true) { }

clippingPlaneToolGet(_:)

Read back the clipping plane parameters stored on a label.

public func clippingPlaneToolGet(_ node: AssemblyNode)
    -> (originX: Double, originY: Double, originZ: Double,
        normalX: Double, normalY: Double, normalZ: Double,
        capping: Bool)?
  • Parameters: node, label node returned by clippingPlaneToolAdd.
  • Returns: A named tuple with origin, normal, and capping flag; nil if the label is not a clipping plane.
  • OCCT: XCAFDoc_ClippingPlaneTool::GetClippingPlane
  • Example: 
    if let node = document.clippingPlaneToolAdd(
    originX: 0, originY: 0, originZ: 0,
    normalX: 1, normalY: 0, normalZ: 0,
    name: "X-cut", capping: false),
   let plane = document.clippingPlaneToolGet(node) {
    print(plane.normalX) // 1.0
}

clippingPlaneToolIsClipPlane(_:)

Test whether a label holds a clipping plane attribute.

public func clippingPlaneToolIsClipPlane(_ node: AssemblyNode) -> Bool
  • Parameters: node, any assembly label node.
  • Returns: true if the label carries a XCAFDoc_ClippingPlane attribute.
  • OCCT: XCAFDoc_ClippingPlaneTool::IsClippingPlane
  • Example: 
    let isPlane = document.clippingPlaneToolIsClipPlane(someNode)

clippingPlaneToolRemove(_:)

Remove a clipping plane from the document.

@discardableResult
public func clippingPlaneToolRemove(_ node: AssemblyNode) -> Bool
  • Parameters: node, label node of the clipping plane to remove.
  • Returns: true if the removal succeeded.
  • OCCT: XCAFDoc_ClippingPlaneTool::RemoveClippingPlane
  • Example: 
    if let node = document.clippingPlaneToolAdd(
    originX: 0, originY: 0, originZ: 0,
    normalX: 0, normalY: 1, normalZ: 0,
    name: "tmp", capping: false) {
    document.clippingPlaneToolRemove(node)
}

XCAFDoc_ShapeMapTool

Extension on AssemblyNode. Maps sub-shapes within a label’s shape for fast membership testing via XCAFDoc_ShapeMapTool.

setShapeMapTool()

Attach a XCAFDoc_ShapeMapTool attribute to this label.

@discardableResult
public func setShapeMapTool() -> Bool
  • Returns: true if the attribute was set successfully.
  • OCCT: XCAFDoc_ShapeMapTool::Set
  • Example: 
    let ok = node.setShapeMapTool()

shapeMapToolSetShape(_:)

Register a shape in the tool’s map, enabling sub-shape lookup.

@discardableResult
public func shapeMapToolSetShape(_ shape: Shape) -> Bool
  • Parameters: shape, the shape whose sub-shapes should be indexed.
  • Returns: true on success.
  • OCCT: XCAFDoc_ShapeMapTool::SetShape
  • Example: 
    if let box = Shape.box(width: 10, height: 10, depth: 10) {
    node.shapeMapToolSetShape(box)
}

shapeMapToolIsSubShape(_:)

Test whether a given shape is a sub-shape of the indexed shape.

public func shapeMapToolIsSubShape(_ shape: Shape) -> Bool
  • Parameters: shape, shape to test for membership.
  • Returns: true if shape is a sub-shape of the shape registered via shapeMapToolSetShape.
  • OCCT: XCAFDoc_ShapeMapTool::IsSubShape
  • Example: 
    let sub: Shape = // an edge or face extracted from the box
let isSub = node.shapeMapToolIsSubShape(sub)

shapeMapToolExtent

Number of entries (sub-shapes) currently in the map.

public var shapeMapToolExtent: Int32 { get }
  • OCCT: XCAFDoc_ShapeMapTool::GetMap().Extent() (via OCCTDocumentShapeMapToolExtent). There is no Map member in OCCT 8.0.1; the accessor is GetMap.
  • Example: 
    print(node.shapeMapToolExtent)

XCAFDoc_AssemblyGraph

AssemblyGraph: a read-only snapshot of the assembly hierarchy as a directed graph. Instantiate once per document and query counts or per-node type.

AssemblyGraph.init?(document:)

Build a graph from a document.

public init?(document: Document)
  • Parameters: document, the document whose assembly structure to traverse.
  • Returns: A populated graph, or nil if the document contains no assembly hierarchy.
  • OCCT: XCAFDoc_AssemblyGraph constructor
  • Example: 
    if let graph = AssemblyGraph(document: document) {
    print(graph.nodeCount)
}

nodeCount

Total number of nodes in the graph.

public var nodeCount: Int32 { get }
  • OCCT: XCAFDoc_AssemblyGraph::NbNodes

linkCount

Total number of directed links (parent→child edges) in the graph.

public var linkCount: Int32 { get }
  • OCCT: XCAFDoc_AssemblyGraph::NbLinks

rootCount

Number of root nodes (nodes with no parent).

public var rootCount: Int32 { get }
  • OCCT: XCAFDoc_AssemblyGraph::GetRoots().Extent() (via OCCTAssemblyGraphNbRoots). There is no NbRoots member in OCCT 8.0.1.

AssemblyGraph.NodeType

Classification of each node in the assembly graph.

public enum NodeType: Int32 {
    case undefined     = 0
    case assemblyRoot  = 1
    case subassembly   = 2
    case occurrence    = 3
    case part          = 4
    case subshape      = 5
}
  • OCCT: XCAFDoc_AssemblyGraph::NodeType

Raw values match XCAFDoc_AssemblyGraph::NodeType’s own raw values in the pinned OCCT 8.0.1 header exactly (NodeType_UNDEFINED=0, NodeType_AssemblyRoot=1, NodeType_Subassembly=2, NodeType_Occurrence=3, NodeType_Part=4, NodeType_Subshape=5). nodeType(at:) decodes XCAFDoc_AssemblyGraph::GetNodeType’s C++ enum value directly via NodeType(rawValue:), with no remapping on either side of the bridge (OCCTAssemblyGraphGetNodeType in OCCTBridge_Document.mm casts the C++ value straight to int32_t), and the case names now match OCCT’s own semantics one-for-one, not just the raw values. Prior to #1568 this enum’s raw values were scrambled (node=0, occurrence=1, part=2, instance=3, subshape=4, free=5), so a caller testing .part was actually testing OCCT’s NodeType_Subassembly; that mapping was verifiably wrong and is not carried forward.

AssemblyGraph.NodeType.undefined

Raw value 0; OCCT’s NodeType_UNDEFINED (undefined node type).

AssemblyGraph.NodeType.assemblyRoot

Raw value 1; OCCT’s NodeType_AssemblyRoot (a root node).

AssemblyGraph.NodeType.subassembly

Raw value 2; OCCT’s NodeType_Subassembly (an intermediate node).

AssemblyGraph.NodeType.occurrence

Raw value 3; OCCT’s NodeType_Occurrence (an assembly/part occurrence node).

AssemblyGraph.NodeType.part

Raw value 4; OCCT’s NodeType_Part (a leaf node representing a part).

AssemblyGraph.NodeType.subshape

Raw value 5; OCCT’s NodeType_Subshape (a subshape node).

nodeType(at:)

Return the type of a node by 1-based index.

public func nodeType(at index: Int32) -> NodeType?
  • Parameters: index, 1-based node index (1 … nodeCount).
  • Returns: The node type, or nil if index is out of range.
  • OCCT: XCAFDoc_AssemblyGraph::GetNodeType
  • Example: 
    if let graph = AssemblyGraph(document: document) {
    for i in 1...graph.nodeCount {
        if let type = graph.nodeType(at: i) {
            print(i, type)
        }
    }
}

XCAFDoc_AssemblyItemId

AssemblyItemId: a lightweight value type representing an assembly path as a /-separated string of label entries (e.g. "0:1:1:1/0:1:1:2").

AssemblyItemId.init(_:)

Create an assembly item ID from a path string.

public init(_ path: String)
  • Parameters: path, colon-and-slash separated label path.
  • OCCT: XCAFDoc_AssemblyItemId constructor
  • Example: 
    let id = AssemblyItemId("0:1:1:1/0:1:1:2")

path

The raw string representation of this item ID.

public let path: String

isValid

Whether the path is a non-empty, well-formed item ID.

public var isValid: Bool { get }
  • OCCT: XCAFDoc_AssemblyItemId::IsNull (negated)
  • Example: 
    let id = AssemblyItemId("")
print(id.isValid) // false

pathCount

Number of individual label entries in the path.

public var pathCount: Int32 { get }
  • OCCT: XCAFDoc_AssemblyItemId::GetPath().Size() (via OCCTAssemblyItemIdPathCount). There is no GetPathLength member in OCCT 8.0.1.
  • Example: 
    let id = AssemblyItemId("0:1:1:1/0:1:1:2")
print(id.pathCount) // 2

isEqual(to:)

Test equality with another item ID.

public func isEqual(to other: AssemblyItemId) -> Bool
  • Parameters: other, the ID to compare.
  • Returns: true if both paths are identical.
  • OCCT: XCAFDoc_AssemblyItemId::IsEqual
  • Example: 
    let a = AssemblyItemId("0:1:1:1")
let b = AssemblyItemId("0:1:1:1")
print(a.isEqual(to: b)) // true

XCAFView_Object

ViewObject: a standalone view definition (camera parameters) that can be stored in an XDE document’s view tool.

ViewObject.init?()

Create a new empty view object.

public init?()
  • Returns: A new view object, or nil if the OCCT handle could not be allocated.
  • OCCT: XCAFView_Object constructor

ViewObject.ProjectionType

Projection mode for this view. Raw values match OCCT’s own XCAFView_ProjectionType exactly (NoCamera=0, Parallel=1, Central=2), so a raw value written or read by another OCCT tool decodes correctly through this API.

public enum ProjectionType: Int32 {
    case noCamera = 0
    case parallel = 1
    case central = 2
}
Case Meaning
noCamera No projection has been assigned yet. OCCT’s own default/unset sentinel, not an error; a freshly-created XCAFView_Object reads as this before setType is ever called.
parallel Orthographic projection (parallel projection rays; no perspective foreshortening).
central Perspective projection (a single view point; distant geometry appears smaller).

ViewObject.ProjectionType.noCamera

No projection assigned (XCAFView_ProjectionType_NoCamera).

  • OCCT: XCAFView_Object::Type / XCAFView_ProjectionType

ViewObject.ProjectionType.parallel

Orthographic projection.

  • OCCT: XCAFView_Object::Type / XCAFView_ProjectionType

ViewObject.ProjectionType.central

Perspective projection.

  • OCCT: XCAFView_Object::Type / XCAFView_ProjectionType

setType(_:)

Set the projection type (no camera, parallel, or central).

public func setType(_ type: ProjectionType)
  • Parameters: type, .noCamera (unset), .parallel (orthographic), or .central (perspective).
  • OCCT: XCAFView_Object::SetType

type

Get the current projection type.

public var type: ProjectionType { get }
  • OCCT: XCAFView_Object::Type
  • Example: 
    if let view = ViewObject() {
    view.setType(.parallel)
    print(view.type) // parallel
}

setViewDirection(x:y:z:)

Set the view direction vector.

public func setViewDirection(x: Double, y: Double, z: Double)
  • OCCT: XCAFView_Object::SetViewDirection

viewDirection

Get the view direction vector as (x, y, z).

public var viewDirection: (x: Double, y: Double, z: Double) { get }
  • OCCT: XCAFView_Object::ViewDirection

setUpDirection(x:y:z:)

Set the up direction vector.

public func setUpDirection(x: Double, y: Double, z: Double)
  • OCCT: XCAFView_Object::SetUpDirection

upDirection

Get the up direction vector as (x, y, z).

public var upDirection: (x: Double, y: Double, z: Double) { get }
  • OCCT: XCAFView_Object::UpDirection

setWindowHorizontalSize(_:)

Set the window horizontal size (used for orthographic scale).

public func setWindowHorizontalSize(_ size: Double)
  • OCCT: XCAFView_Object::SetWindowHorizontalSize

windowHorizontalSize

Get the window horizontal size.

public var windowHorizontalSize: Double { get }
  • OCCT: XCAFView_Object::WindowHorizontalSize

setWindowVerticalSize(_:)

Set the window vertical size.

public func setWindowVerticalSize(_ size: Double)
  • OCCT: XCAFView_Object::SetWindowVerticalSize

windowVerticalSize

Get the window vertical size.

public var windowVerticalSize: Double { get }
  • OCCT: XCAFView_Object::WindowVerticalSize

setFrontPlaneDistance(_:)

Set the front clipping plane distance and enable front clipping.

public func setFrontPlaneDistance(_ dist: Double)
  • OCCT: XCAFView_Object::SetFrontPlaneDistance

frontPlaneDistance

Get the front clipping plane distance.

public var frontPlaneDistance: Double { get }
  • OCCT: XCAFView_Object::FrontPlaneDistance

hasFrontPlaneClipping

Whether front plane clipping is enabled for this view.

public var hasFrontPlaneClipping: Bool { get }
  • OCCT: XCAFView_Object::HasFrontPlaneClipping

unsetFrontPlaneClipping()

Disable front plane clipping.

public func unsetFrontPlaneClipping()
  • OCCT: XCAFView_Object::UnsetFrontPlaneClipping

setBackPlaneDistance(_:)

Set the back clipping plane distance and enable back clipping.

public func setBackPlaneDistance(_ dist: Double)
  • OCCT: XCAFView_Object::SetBackPlaneDistance

backPlaneDistance

Get the back clipping plane distance.

public var backPlaneDistance: Double { get }
  • OCCT: XCAFView_Object::BackPlaneDistance

hasBackPlaneClipping

Whether back plane clipping is enabled for this view.

public var hasBackPlaneClipping: Bool { get }
  • OCCT: XCAFView_Object::HasBackPlaneClipping

unsetBackPlaneClipping()

Disable back plane clipping.

public func unsetBackPlaneClipping()
  • OCCT: XCAFView_Object::UnsetBackPlaneClipping

setName(_:)

Set a display name for this view.

public func setName(_ name: String)
  • OCCT: XCAFView_Object::SetName

name

Get the display name, or nil if none has been set.

public var name: String? { get }
  • OCCT: XCAFView_Object::Name
  • Example: 
    if let view = ViewObject() {
    view.setName("Front")
    print(view.name ?? "") // "Front"
}

XCAFNoteObjects_NoteObject

NoteObject: annotation geometry data (plane, point, presentation shape) associated with a note.

NoteObject.init?()

Create a new empty note object.

public init?()
  • Returns: A new note object, or nil if allocation fails.
  • OCCT: XCAFNoteObjects_NoteObject constructor

hasPlane

Whether a plane has been set on this note object.

public var hasPlane: Bool { get }
  • OCCT: XCAFNoteObjects_NoteObject::HasPlane

hasPoint

Whether a 3-D anchor point has been set.

public var hasPoint: Bool { get }
  • OCCT: XCAFNoteObjects_NoteObject::HasPoint

hasPointText

Whether a point-text annotation has been set.

public var hasPointText: Bool { get }
  • OCCT: XCAFNoteObjects_NoteObject::HasPointText

setPlane(originX:originY:originZ:normalX:normalY:normalZ:)

Set the annotation plane by origin point and normal direction.

public func setPlane(
    originX: Double, originY: Double, originZ: Double,
    normalX: Double, normalY: Double, normalZ: Double
)
  • OCCT: XCAFNoteObjects_NoteObject::SetPlane

planeOrigin

Get the origin of the annotation plane as (x, y, z).

public var planeOrigin: (x: Double, y: Double, z: Double) { get }
  • OCCT: XCAFNoteObjects_NoteObject::GetPlane (origin component)
  • Note: Returns the plane origin only; the normal is not separately exposed at the Swift level.

setPoint(x:y:z:)

Set the 3-D anchor point of the note.

public func setPoint(x: Double, y: Double, z: Double)
  • OCCT: XCAFNoteObjects_NoteObject::SetPoint

point

Get the anchor point as (x, y, z).

public var point: (x: Double, y: Double, z: Double) { get }
  • OCCT: XCAFNoteObjects_NoteObject::GetPoint

setPresentation(_:)

Attach a shape as the visual presentation for the note callout.

public func setPresentation(_ shape: Shape)
  • Parameters: shape, any Shape to use as the note’s geometry.
  • OCCT: XCAFNoteObjects_NoteObject::SetPresentation

presentation

Get the presentation shape, or nil if none has been set.

public var presentation: Shape? { get }
  • OCCT: XCAFNoteObjects_NoteObject::GetPresentation

reset()

Clear all data (plane, point, presentation) on this note object.

public func reset()
  • OCCT: XCAFNoteObjects_NoteObject::Reset
  • Example: 
    if let note = NoteObject() {
    note.setPoint(x: 1, y: 2, z: 3)
    note.reset()
    print(note.hasPoint) // false
}

XCAFPrs_Style

PresentationStyle: a value type capturing surface color, curve color, alpha, and visibility for a shape in an XDE scene.

PresentationStyle.init()

Create an empty style (no colors set, fully opaque, visible).

public init()
  • OCCT: XCAFPrs_Style default constructor

PresentationStyle.init(surfaceRed:surfaceGreen:surfaceBlue:surfaceAlpha:)

Create a style with a surface color and optional alpha.

public init(
    surfaceRed: Double,
    surfaceGreen: Double,
    surfaceBlue: Double,
    surfaceAlpha: Float = 1.0
)
  • Parameters: surfaceRed/Green/Blue, RGB in [0, 1]; surfaceAlpha, opacity in [0, 1], default 1.0.
  • OCCT: XCAFPrs_Style::SetColorSurf
  • Example: 
    let red = PresentationStyle(surfaceRed: 1, surfaceGreen: 0, surfaceBlue: 0)

surfaceColor

The surface (face fill) color as an optional (red, green, blue) tuple.

public var surfaceColor: (red: Double, green: Double, blue: Double)?

surfaceAlpha

Surface opacity (0 = transparent, 1 = opaque).

public var surfaceAlpha: Float

curveColor

The curve (edge/wire) color as an optional (red, green, blue) tuple.

public var curveColor: (red: Double, green: Double, blue: Double)?

isVisible

Whether this style marks the shape as visible.

public var isVisible: Bool

isEmpty

Whether the style carries no color attributes and is fully visible (default state).

public var isEmpty: Bool { get }
  • OCCT: XCAFPrs_Style::IsEmpty

isEqual(to:)

Test equality with another PresentationStyle.

public func isEqual(to other: PresentationStyle) -> Bool
  • OCCT: XCAFPrs_Style::IsEqual
  • Example: 
    var s1 = PresentationStyle()
var s2 = PresentationStyle()
print(s1.isEqual(to: s2)) // true

XCAFDoc_VisMaterialCommon

VisMaterialCommon: Phong shading parameters (diffuse, ambient, specular, emissive, shininess, transparency).

VisMaterialCommon.init()

Create material with OCCT default values.

public init()
  • OCCT: XCAFDoc_VisMaterialCommon default field values

diffuseColor

Diffuse color as (red, green, blue).

public var diffuseColor: (red: Double, green: Double, blue: Double)

ambientColor

Ambient color as (red, green, blue).

public var ambientColor: (red: Double, green: Double, blue: Double)

specularColor

Specular highlight color as (red, green, blue).

public var specularColor: (red: Double, green: Double, blue: Double)

emissiveColor

Emissive (self-illuminating) color as (red, green, blue).

public var emissiveColor: (red: Double, green: Double, blue: Double)

shininess

Phong shininess exponent.

public var shininess: Float

transparency

Transparency in [0, 1] (0 = opaque).

public var transparency: Float

isDefined

Whether this material has been explicitly defined (as opposed to being a placeholder).

public var isDefined: Bool

isEqual(to:)

Test equality with another VisMaterialCommon.

public func isEqual(to other: VisMaterialCommon) -> Bool
  • OCCT: XCAFDoc_VisMaterialCommon::IsEqual
  • Example: 
    let m1 = VisMaterialCommon()
let m2 = VisMaterialCommon()
print(m1.isEqual(to: m2)) // true

XCAFDoc_VisMaterialPBR

VisMaterialPBR: PBR (physically-based rendering) material parameters.

VisMaterialPBR.init()

Create PBR material with OCCT default values.

public init()
  • OCCT: XCAFDoc_VisMaterialPBR default field values

baseColor

Base color as (red, green, blue).

public var baseColor: (red: Double, green: Double, blue: Double)

baseColorAlpha

Base color alpha (opacity).

public var baseColorAlpha: Float

metallic

Metallic factor in [0, 1].

public var metallic: Float

roughness

Roughness factor in [0, 1].

public var roughness: Float

refractionIndex

Index of refraction (IOR).

public var refractionIndex: Float

emissionColor

Emission color as (red, green, blue).

public var emissionColor: (red: Double, green: Double, blue: Double)

isDefined

Whether this PBR material has been explicitly defined.

public var isDefined: Bool

isEqual(to:)

Test equality with another VisMaterialPBR.

public func isEqual(to other: VisMaterialPBR) -> Bool
  • OCCT: XCAFDoc_VisMaterialPBR::IsEqual
  • Example: 
    var m1 = VisMaterialPBR()
m1.metallic = 0.8
var m2 = VisMaterialPBR()
print(m1.isEqual(to: m2)) // false

VrmlAPI_Writer

VRML export for Shape and Document objects.

VrmlRepresentation

Visual representation mode for VRML export.

public enum VrmlRepresentation: Int32, Sendable {
    case shaded    = 0
    case wireFrame = 1
    case both      = 2
}
  • OCCT: VrmlAPI_RepresentationOfShape
case meaning
.shaded Export shaded (faceted) geometry only.
.wireFrame Export wireframe (edge) geometry only.
.both Export both shaded and wireframe representations.

(Per-case anchors below, for cross-reference; the table above has the actual meaning of each.)

both

Shape.writeVRML(to:version:deflection:representation:)

Write a shape to a VRML file.

@discardableResult
public func writeVRML(
    to url: URL,
    version: Int = 2,
    deflection: Double = 0.01,
    representation: VrmlRepresentation = .shaded
) -> Bool
  • Parameters: url, destination file URL (.wrl); version, VRML version (1 or 2); deflection, triangulation chord deviation; representation, shading mode.
  • Returns: true on success.
  • OCCT: VrmlAPI_Writer::Write
  • Example: 
    if let box = Shape.box(width: 10, height: 10, depth: 10) {
    box.writeVRML(to: URL(fileURLWithPath: "/tmp/box.wrl"))
}

Document.writeVRML(to:scale:)

Write an XDE document to a VRML file, applying a uniform scale.

@discardableResult
public func writeVRML(to url: URL, scale: Double = 1.0) -> Bool
  • Parameters: url, destination file URL (.wrl); scale, uniform scale factor applied before export.
  • Returns: true on success.
  • OCCT: VrmlAPI_Writer::WriteDoc
  • Example: 
    let ok = document.writeVRML(to: URL(fileURLWithPath: "/tmp/model.wrl"), scale: 0.001)

TDataStd_Directory

Hierarchical container attribute for grouping OCAF labels, analogous to a filesystem directory.

createDirectory(at:)

Create a TDataStd_Directory attribute on a label.

@discardableResult
public func createDirectory(at labelTag: Int = 0) -> Bool
  • Parameters: labelTag, child tag of the main label to target (0 = main label).
  • Returns: true if the attribute was created.
  • OCCT: TDataStd_Directory::New
  • Example: 
    document.createDirectory()

hasDirectory(at:)

Check whether a TDataStd_Directory attribute exists on a label.

public func hasDirectory(at labelTag: Int = 0) -> Bool
  • OCCT: TDataStd_Directory::Find
  • Example: 
    if document.hasDirectory() { }

addSubDirectory(under:)

Create a child directory label under an existing directory.

public func addSubDirectory(under parentLabelTag: Int = 0) -> Int?
  • Parameters: parentLabelTag, label tag of the parent directory.
  • Returns: The child label tag, or nil on failure.
  • OCCT: TDataStd_Directory::AddDirectory
  • Example: 
    if let childTag = document.addSubDirectory() {
    print(childTag)
}

makeObjectLabel(under:)

Create an object (leaf) label under a directory.

public func makeObjectLabel(under parentLabelTag: Int = 0) -> Int?
  • Parameters: parentLabelTag, label tag of the parent directory.
  • Returns: The new label tag, or nil on failure.
  • OCCT: TDataStd_Directory::MakeObjectLabel

TDataStd_Variable

Parametric variable attributes stored on OCAF labels. Variables may be named, typed, unit-annotated, and linked to expressions.

setVariable(at:)

Attach a TDataStd_Variable attribute to a label.

@discardableResult
public func setVariable(at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::Set

setVariableName(_:at:)

Set the display name of a variable.

@discardableResult
public func setVariableName(_ name: String, at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::Name

variableName(at:)

Get the display name of a variable, or nil if not set.

public func variableName(at labelTag: Int) -> String?
  • OCCT: TDataStd_Variable::Name

setVariableValue(_:at:)

Set the numeric value of a variable.

@discardableResult
public func setVariableValue(_ value: Double, at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::Set (real-valued overload)

variableValue(at:)

Get the numeric value stored on a variable label.

public func variableValue(at labelTag: Int) -> Double
  • OCCT: TDataStd_Variable::Get

variableIsValued(at:)

Whether the variable label holds a numeric value.

public func variableIsValued(at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::IsValued

setVariableUnit(_:at:)

Attach a unit string (e.g. "mm") to a variable.

@discardableResult
public func setVariableUnit(_ unit: String, at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::Unit

variableUnit(at:)

Get the unit string for a variable, or nil if not set.

public func variableUnit(at labelTag: Int) -> String?
  • OCCT: TDataStd_Variable::Unit

setVariableConstant(_:at:)

Mark a variable as a constant (prevents parametric modification).

@discardableResult
public func setVariableConstant(_ isConstant: Bool, at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::Constant

variableIsConstant(at:)

Whether the variable is marked constant.

public func variableIsConstant(at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::IsConstant

assignExpression(at:)

Assign an expression attribute to a variable on the same label.

@discardableResult
public func assignExpression(at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::Assign

desassignExpression(at:)

Remove an expression assignment from a variable.

@discardableResult
public func desassignExpression(at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::Desassign

variableIsAssigned(at:)

Whether the variable currently has an expression assigned.

public func variableIsAssigned(at labelTag: Int) -> Bool
  • OCCT: TDataStd_Variable::IsAssigned
  • Example: 
    document.setVariable(at: 1)
document.setVariableName("Width", at: 1)
document.setVariableValue(50.0, at: 1)
document.setVariableUnit("mm", at: 1)
print(document.variableIsValued(at: 1)) // true

TDataStd_Expression

Algebraic expression string attributes stored on OCAF labels, evaluated by a constraint solver.

setExpression(at:)

Attach a TDataStd_Expression attribute to a label.

@discardableResult
public func setExpression(at labelTag: Int) -> Bool
  • OCCT: TDataStd_Expression::Set

setExpressionString(_:at:)

Set the expression string on a label.

@discardableResult
public func setExpressionString(_ expression: String, at labelTag: Int) -> Bool
  • Parameters: expression, formula string (e.g. "Width * 2").
  • OCCT: TDataStd_Expression::SetExpression (via OCCTDocumentExpressionSetString).

expressionString(at:)

Get the expression formula string, or nil if not set.

public func expressionString(at labelTag: Int) -> String?
  • OCCT: TDataStd_Expression::GetExpression (via OCCTDocumentExpressionGetString).

expressionName(at:)

Get the expression name (variable name it is bound to), or nil if not set.

public func expressionName(at labelTag: Int) -> String?
  • OCCT: TDataStd_Expression::Name
  • Example: 
    document.setExpression(at: 2)
document.setExpressionString("50 * 2", at: 2)
print(document.expressionString(at: 2) ?? "") // "50 * 2"

External link attributes that cross-reference labels in other documents.

setXLink(at:)

Attach a TDocStd_XLink attribute to a label.

@discardableResult
public func setXLink(at labelTag: Int) -> Bool
  • OCCT: TDocStd_XLink::Set

setXLinkDocumentEntry(_:at:)

Set the document entry path (URL or path) of the external link.

@discardableResult
public func setXLinkDocumentEntry(_ entry: String, at labelTag: Int) -> Bool
  • OCCT: TDocStd_XLink::DocumentEntry(entry), the setter overload (via OCCTDocumentXLinkSetDocumentEntry).

xLinkDocumentEntry(at:)

Get the document entry path of the external link, or nil if not set.

public func xLinkDocumentEntry(at labelTag: Int) -> String?
  • OCCT: TDocStd_XLink::DocumentEntry(), the getter overload (via OCCTDocumentXLinkGetDocumentEntry).

setXLinkLabelEntry(_:at:)

Set the label entry string (e.g. "0:1:2") within the external document.

@discardableResult
public func setXLinkLabelEntry(_ entry: String, at labelTag: Int) -> Bool
  • OCCT: TDocStd_XLink::LabelEntry(entry), the setter overload (via OCCTDocumentXLinkSetLabelEntry).

xLinkLabelEntry(at:)

Get the label entry string of the external link, or nil if not set.

public func xLinkLabelEntry(at labelTag: Int) -> String?
  • OCCT: TDocStd_XLink::LabelEntry(), the getter overload (via OCCTDocumentXLinkGetLabelEntry).
  • Example: 
    document.setXLink(at: 3)
document.setXLinkDocumentEntry("/models/base.xde", at: 3)
document.setXLinkLabelEntry("0:1:1", at: 3)
print(document.xLinkDocumentEntry(at: 3) ?? "")

XCAFDimTolObjects_Tool

Read-only query interface for dimension and geometric tolerance objects stored in the XCAF DimTol subsystem.

dimTolToolDimensionCount

Number of dimension annotation objects in the document.

public var dimTolToolDimensionCount: Int { get }
  • OCCT: XCAFDimTolObjects_Tool dimension list size
  • Example: 
    print(document.dimTolToolDimensionCount)

dimTolToolToleranceCount

Number of geometric tolerance annotation objects in the document.

public var dimTolToolToleranceCount: Int { get }
  • Returns: the tolerance count. This used to answer 0 whenever any datum attached to a tolerance carried an annotation point with no annotation plane, which the bridge refused rather than crash OCCT; carried patch 0029 fixes the kernel read and is pinned as of v4.0.0-kernel.1, so the count is now the real one (#1030). See the note under datum(at:).
  • OCCT: XCAFDimTolObjects_Tool tolerance list size
  • Example: 
    print(document.dimTolToolToleranceCount)

TPrsStd_DriverTable

DriverTable: a caseless enum namespace for managing the global singleton table of OCAF presentation drivers.

DriverTable.initStandard()

Populate the global driver table with the standard set of OCAF presentation drivers.

public static func initStandard()
  • OCCT: TPrsStd_DriverTable::Get().InitStandardDrivers(), which registers the six standard TPrsStd_Driver subclasses (TPrsStd_AxisDriver, ConstraintDriver, GeometryDriver, NamedShapeDriver, PlaneDriver, PointDriver), not TPrsStd_AISPresentation (#982 measured InitStandardDrivers()’s own body: it binds those six GUIDs and never touches TPrsStd_AISPresentation, which is a separate attribute class this bridge does not construct).
  • Example: 
    DriverTable.initStandard()

DriverTable.exists

Always true. TPrsStd_DriverTable::Get()’s own header doc says it lazily creates the table (and fills it with standard drivers) if one does not already exist, so this can never observe a “not yet created” state – reading it is itself what creates and populates the global table on first use. There is no OCCT query that reports existence without also creating it.

public static var exists: Bool { get }
  • OCCT: TPrsStd_DriverTable::Get (non-nil check; Get() itself always creates on demand, so the check never fails)

DriverTable.clear()

Remove all drivers from the global table.

public static func clear()
  • OCCT: TPrsStd_DriverTable::Get().Clear()
  • Example: 
    DriverTable.clear()

TObj_Application

TObjApplication: Swift wrapper for the TObj_Application singleton, the OCAF application context for TObj-based documents.

TObjApplication.shared

Get the singleton TObj_Application instance.

public static var shared: TObjApplication? { get }
  • Returns: The singleton, or nil if the OCAF framework has not been initialized.
  • OCCT: TObj_Application::GetInstance
  • Example: 
    if let app = TObjApplication.shared {
    let doc = app.createDocument()
}

isVerbose

Whether verbose diagnostic logging is enabled on this TObj application.

public var isVerbose: Bool { get set }
  • OCCT: TObj_Application::IsVerbose / TObj_Application::SetVerbose

createDocument()

Create a new Document managed by this TObj application.

public func createDocument() -> Document?
  • Returns: A new document, or nil if the OCAF framework could not allocate one.
  • OCCT: TObj_Application::CreateNewDocument (not TDocStd_Application::NewDocument, which TObj_Application inherits but never overrides and this call never reaches; #982 measured the divergence).
  • Example: 
    if let app = TObjApplication.shared, let doc = app.createDocument() {
    print(doc.shapeCount)   // 0, a fresh document
}

UnitsAPI

Units: a caseless enum namespace for unit conversion via OCCT’s UnitsAPI.

Units.convert(_:from:to:)

Convert a value from one named unit to another.

public static func convert(_ value: Double, from fromUnit: String, to toUnit: String) -> Double
  • Parameters: value, numeric quantity; fromUnit, source unit name (e.g. "mm"); toUnit, target unit name (e.g. "m").
  • Returns: Converted value.
  • OCCT: UnitsAPI::AnyToAny
  • Example: 
    let meters = Units.convert(1000, from: "mm", to: "m") // 1.0

Units.toSI(_:from:)

Convert a value from a named unit to its SI base unit.

public static func toSI(_ value: Double, from unit: String) -> Double
  • OCCT: UnitsAPI::AnyToSI
  • Example: 
    let radians = Units.toSI(180, from: "deg") // π

Units.fromSI(_:to:)

Convert a value from the SI base unit to a named unit.

public static func fromSI(_ value: Double, to unit: String) -> Double
  • OCCT: UnitsAPI::AnyFromSI

Units.toLocalSystem(_:from:)

Convert a value from a named unit to the local unit system.

public static func toLocalSystem(_ value: Double, from unit: String) -> Double
  • OCCT: UnitsAPI::AnyToLS

Units.fromLocalSystem(_:to:)

Convert a value from the local unit system to a named unit.

public static func fromLocalSystem(_ value: Double, to unit: String) -> Double
  • OCCT: UnitsAPI::AnyFromLS

Units.SystemType

Available local unit system presets.

public enum SystemType: Int32, Sendable {
    case defaultSystem = 0
    case si            = 1
    case mdtv          = 2
}

Case meanings, from UnitsAPI_SystemUnits:

Units.SystemType.defaultSystem

The default system; equivalent to .si.

Units.SystemType.si

The SI unit system (metres and their derivatives).

Units.SystemType.mdtv

Equivalent to the SI system, except the length unit and its derivatives use millimetres instead of metres.

  • OCCT: UnitsAPI_SystemUnits

Units.setLocalSystem(_:)

Set the local unit system used by toLocalSystem / fromLocalSystem.

public static func setLocalSystem(_ system: SystemType)
  • OCCT: UnitsAPI::SetLocalSystem
  • Example: 
    Units.setLocalSystem(.si)

Units.localSystem

Get the current local unit system.

public static var localSystem: SystemType { get }
  • OCCT: UnitsAPI::LocalSystem

BinTools Shape I/O

Binary serialisation for Shape using OCCT’s BinTools format (compact, version-stable), via the object-oriented BinTools_ShapeWriter/BinTools_ShapeReader classes rather than the bare BinTools package’s own static Write/Read methods.

Shape.toBinaryData()

Serialise this shape to an in-memory binary blob.

public func toBinaryData() -> Data?
  • Returns: Data containing the binary shape representation, or nil if serialisation fails.
  • OCCT: BinTools_ShapeWriter::Write
  • Example: 
    if let box = Shape.box(width: 10, height: 10, depth: 10),
   let data = box.toBinaryData() {
    let restored = Shape.fromBinaryData(data)
}

Shape.fromBinaryData(_:)

Deserialise a shape from a binary blob produced by toBinaryData().

public static func fromBinaryData(_ data: Data) -> Shape?
  • Parameters: data, binary data previously produced by toBinaryData().
  • Returns: The restored Shape, or nil if the data is invalid.
  • OCCT: BinTools_ShapeReader::Read

Shape.writeBinary(to:)

Write this shape to a binary file.

@discardableResult
public func writeBinary(to url: URL) -> Bool
  • Parameters: url, destination file URL.
  • Returns: true on success.
  • OCCT: BinTools_ShapeWriter::Write (file overload)
  • Example: 
    if let box = Shape.box(width: 5, height: 5, depth: 5) {
    box.writeBinary(to: URL(fileURLWithPath: "/tmp/box.bin"))
}

Shape.loadBinary(from:)

Read a shape from a binary file written by writeBinary(to:).

public static func loadBinary(from url: URL) -> Shape?
  • Parameters: url, source file URL.
  • Returns: The restored Shape, or nil if the file is missing or invalid.
  • OCCT: BinTools_ShapeReader::Read (file overload)
  • Example: 
    if let shape = Shape.loadBinary(from: URL(fileURLWithPath: "/tmp/box.bin")) {
    print(shape.isValid)
}

Message_Messenger

Messenger: a thin wrapper around OCCT’s Message_Messenger, allowing messages to be dispatched to one or more attached printers (stdout, file, custom).

Messenger.Gravity

Severity levels for messages.

public enum Gravity: Int32, Sendable {
    case trace   = 0
    case info    = 1
    case warning = 2
    case alarm   = 3
    case fail    = 4
}

Case meanings, from Message_Gravity:

Messenger.Gravity.trace

Low-level details on algorithm execution, usually for debugging.

Messenger.Gravity.warning

A warning message.

Messenger.Gravity.alarm

A non-critical error.

Messenger.Gravity.fail

A fatal error.

  • OCCT: Message_Gravity

Messenger.init?()

Create a messenger with a default stdout printer attached.

public init?()
  • Returns: A messenger, or nil if OCCT allocation fails.
  • OCCT: Message_Messenger() (default constructor).
  • Example: 
    if let messenger = Messenger() {
    messenger.send("Hello from OCCTSwift", gravity: .info)
}

printerCount

Number of printers currently attached to this messenger.

public var printerCount: Int { get }
  • OCCT: Message_Messenger::Printers().Size()

send(_:gravity:)

Dispatch a message to all attached printers at the given severity.

public func send(_ message: String, gravity: Gravity = .info)
  • Parameters: message, message text; gravity, severity level (default .info).
  • OCCT: Message_Messenger::Send
  • Example: 
    if let messenger = Messenger() {
    messenger.send("Tolerance exceeded", gravity: .warning)
}

addFilePrinter(path:gravity:)

Attach a file printer that writes messages at or above the given gravity to a log file.

@discardableResult
public func addFilePrinter(path: String, gravity: Gravity = .info) -> Bool
  • Parameters: path, filesystem path for the log file; gravity, minimum severity to log.
  • Returns: true if the printer was attached successfully.
  • OCCT: Message_PrinterOStream / Message_Messenger::AddPrinter
  • Example: 
    if let messenger = Messenger() {
    messenger.addFilePrinter(path: "/tmp/occt.log", gravity: .warning)
    messenger.send("Test warning", gravity: .warning)
}

removeAllPrinters()

Detach all printers from this messenger.

public func removeAllPrinters()
  • OCCT: Message_Messenger::RemovePrinters(Message_Printer) (via OCCTMessengerRemoveAllPrinters).