# BCFTopic

class `Bcf.``BCFTopic`()

  This class contains data corresponding to a BCF file topic.

  ## Index

  Constructors

  - `constructor`

  Methods

  - `addMarkup`
  - `addSnapshot`
  - `addViewpoint`
  - `getMarkup`
  - `getSnapshot`
  - `getSnapshotMap`
  - `getTopicId`
  - `getViewpoint`
  - `getViewpointMap`
  - `setSnapshot`
  - `setViewpoint`
  - `createTopic`

## Constructors

`Bcf.BCFTopic.``constructor`()
  BCFTopic(bcfDataId: number, bcfFilename: string, topicId: string, viewer: `IWebViewer`): `BCFTopic`

  Parameters

  > bcfDataId: number

  > bcfFilename: string

  > topicId: string

  > viewer: `IWebViewer`

  Returns: `BCFTopic`

## Methods

`Bcf.BCFTopic.``addMarkup`()
  addMarkup(filename: string, document: (None | Document)): `BCFMarkup`

  Adds a BCF markup.

  Parameters

  > filename: string

  > document: (None | Document)

  Returns: `BCFMarkup`

`Bcf.BCFTopic.``addSnapshot`()
  addSnapshot(filename: string, png: Uint8Array): void

  Creates and adds a Snapshot.

  Parameters

  > filename: string

  > png: Uint8Array

  > > Image data.

  Returns: void

`Bcf.BCFTopic.``addViewpoint`()
  addViewpoint(filename: string, document: (None | Document), version: `BCFVersion`, modelBounding: `Box`, modelUnits: number): `BCFViewpoint`

  Creates and adds BCF viewpoint.

  Parameters

  > filename: string

  > document: (None | Document)

  > version: `BCFVersion`

  > modelBounding: `Box`

  > modelUnits: number

  Returns: `BCFViewpoint`

`Bcf.BCFTopic.``getMarkup`()
  getMarkup(): `BCFMarkup`

  Returns: `BCFMarkup`

  > BCF markup data.

`Bcf.BCFTopic.``getSnapshot`()
  getSnapshot(filename: string): (None | `BCFSnapshot`)

  Gets snapshot data.

  Parameters

  > filename: string

  > > snapshot or corresponding viewpoint filename

  Returns: (None | `BCFSnapshot`)

`Bcf.BCFTopic.``getSnapshotMap`()
  getSnapshotMap(): Map

  Returns: Map

  > A map associating snapshot filenames with snapshot data.

`Bcf.BCFTopic.``getTopicId`()
  getTopicId(): string

  Gets the topic id corresponding to the BCF topic folder.

  Returns: string

`Bcf.BCFTopic.``getViewpoint`()
  getViewpoint(filename: string): (None | `BCFViewpoint`)

  Gets viewpoint data.

  Parameters

  > filename: string

  > > viewpoint filename.

  Returns: (None | `BCFViewpoint`)

`Bcf.BCFTopic.``getViewpointMap`()
  getViewpointMap(): Map

  Returns: Map

  > A map associating viewpoint filenames with viewpoint data.

`Bcf.BCFTopic.``setSnapshot`()
  setSnapshot(filename: string, snapshot: `BCFSnapshot`): void

  Adds a BCF Snapshot. If there is already a snapshot with the smae filename, it will be replaced.

  Parameters

  > filename: string

  > snapshot: `BCFSnapshot`

  Returns: void

`Bcf.BCFTopic.``setViewpoint`()
  setViewpoint(filename: string, viewpoint: `BCFViewpoint`): void

  Adds a BCF Viewpoint. If there is a already a viewpoint with the same filename, it will be replaced.

  Parameters

  > filename: string

  > viewpoint: `BCFViewpoint`

  Returns: void

`static Bcf.BCFTopic.``createTopic`()

  static

  createTopic(viewer: `IWebViewer`, bcfDataId: number, bcfFilename: string, topicTitle: string, markupView: (None | `MarkupView`)?): Promise

  Takes a MarkupView and creates a BCF Topic from it.

  Parameters

  > viewer: `IWebViewer`

  > bcfDataId: number

  > bcfFilename: string

  > topicTitle: string

  > markupView: (None | `MarkupView`) = null

  Returns: Promise

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...