Anark Core SDK
Loading...
Searching...
No Matches
Anark.CoreSdkApi.Entities.ISdkAnnotation Interface Reference

Annotation shapes must implement this interface. More...

Public Member Functions

ISdkAnnotationGeometry GetGeometry (ISdkTextRenderer textRenderer)
 This is called to retrieve the geometry from your annotation object when the annotation is added to the Anark Core object model (via the API).

Properties

string Name [get]
 The name of the annotation. This will be published and visible in the UI.

Detailed Description

Annotation shapes must implement this interface.

Member Function Documentation

◆ GetGeometry()

ISdkAnnotationGeometry Anark.CoreSdkApi.Entities.ISdkAnnotation.GetGeometry ( ISdkTextRenderer textRenderer)

This is called to retrieve the geometry from your annotation object when the annotation is added to the Anark Core object model (via the API).

Parameters
textRendererThis is provided to produce geometry from text strings.
Returns
The 2D Geometry that defines the entire annotation, including any text. This geometry will be converted to 3D when the annotation is added via the API.

Property Documentation

◆ Name

string Anark.CoreSdkApi.Entities.ISdkAnnotation.Name
get

The name of the annotation. This will be published and visible in the UI.