# BCFViewpoint

class `Bcf.``BCFViewpoint`()

  ## Index

  Constructors

  - `constructor`

  Methods

  - `activate`
  - `export`
  - `getCamera`
  - `getClippingPlanes`
  - `getColors`
  - `getColorsToNodes`
  - `getFilename`
  - `getLines`
  - `getSelection`
  - `getSelectionNodes`
  - `getViewpointGuid`
  - `getVisibilityExceptionNodes`
  - `getVisibilityExceptions`
  - `setCamera`
  - `setClippingPlanes`
  - `setColorNodes`
  - `setColors`
  - `setDefaultVisibility`
  - `setLines`
  - `setSelection`
  - `setSelectionNodes`
  - `setVisibilityExceptionNodes`
  - `setVisibilityExceptions`
  - `createViewpoint`

## Constructors

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

  Parameters

  > filename: string

  > document: (None | Document)

  > version: `BCFVersion`

  > modelBounding: `Box`

  > modelUnits: number

  > viewer: `IWebViewer`

  Returns: `BCFViewpoint`

## Methods

`Bcf.BCFViewpoint.``activate`()
  activate(): Promise

  Activates viewpoint. Sets the camera, visibility, cutting planes, colors, and markup.

  Returns: Promise

`Bcf.BCFViewpoint.``export`()
  export(): XMLDocument

  Returns: XMLDocument

  > XML document containing the viewpoint data.

`Bcf.BCFViewpoint.``getCamera`()
  getCamera(): (None | `Camera`)

  Gets the viewpoint camera, or null if none is set.

  Returns: (None | `Camera`)

`Bcf.BCFViewpoint.``getClippingPlanes`()
  getClippingPlanes(): [`Point3`, `Point3`][]

  Gets the clipping planes.

  Returns: [`Point3`, `Point3`][]

  > Array containing position and direction pairs.

`Bcf.BCFViewpoint.``getColors`()
  getColors(): Map

  Returns: Map

  > Map correlating color to components.

`Bcf.BCFViewpoint.``getColorsToNodes`()
  getColorsToNodes(): Map

  Returns: Map

  > Map correlating color to nodes.

`Bcf.BCFViewpoint.``getFilename`()
  getFilename(): string

  Gets the viewpoint filename.

  Returns: string

`Bcf.BCFViewpoint.``getLines`()
  getLines(): [`Point3`, `Point3`][]

  Gets markup lines.

  Returns: [`Point3`, `Point3`][]

  > Array containing start point and end point line pairs.

`Bcf.BCFViewpoint.``getSelection`()
  getSelection(): string[]

  Gets a list of generic IDs that are in the selection set.

  Returns: string[]

`Bcf.BCFViewpoint.``getSelectionNodes`()
  getSelectionNodes(): number[]

  Gets a list of node IDs that are in the selection set.

  Returns: number[]

`Bcf.BCFViewpoint.``getViewpointGuid`()
  getViewpointGuid(): (None | string)

  Gets the GUID associated with the viewpoint.

  Returns: (None | string)

`Bcf.BCFViewpoint.``getVisibilityExceptionNodes`()
  getVisibilityExceptionNodes(): number[]

  Gets the visibility exception node ids.

  Returns: number[]

  > Array of NodeIds corresponding to components.

`Bcf.BCFViewpoint.``getVisibilityExceptions`()
  getVisibilityExceptions(): string[]

  Gets the visibility exception generic ids.

  Returns: string[]

  > Array of GenericIds corresponding to components.

`Bcf.BCFViewpoint.``setCamera`()
  setCamera(camera: `Camera`): void

  Sets the viewpoint camera.

  Parameters

  > camera: `Camera`

  Returns: void

`Bcf.BCFViewpoint.``setClippingPlanes`()
  setClippingPlanes(planes: [`Point3`, `Point3`][]): void

  Sets the clipping planes.

  Parameters

  > planes: [`Point3`, `Point3`][]

  > > array containing position and direction pairs.

  Returns: void

`Bcf.BCFViewpoint.``setColorNodes`()
  setColorNodes(colorNodeMap: Map): void

  Sets the colors.

  Parameters

  > colorNodeMap: Map

  > > Map correlating color to BfcNodes.

  Returns: void

`Bcf.BCFViewpoint.``setColors`()
  setColors(colorGenericIdMap: Map): void

  Sets the colors.

  Parameters

  > colorGenericIdMap: Map

  > > Map correlating color to GenericIds.

  Returns: void

`Bcf.BCFViewpoint.``setDefaultVisibility`()
  setDefaultVisibility(defaultVisibility: boolean): void

  Sets the default visibility. If true, visibility exceptions are hidden. If false, visibility exceptions are shown.

  Parameters

  > defaultVisibility: boolean

  Returns: void

`Bcf.BCFViewpoint.``setLines`()
  setLines(lines: [`Point3`, `Point3`][]): void

  Sets the markup lines.

  Parameters

  > lines: [`Point3`, `Point3`][]

  > > array of start point and end point line pairs.

  Returns: void

`Bcf.BCFViewpoint.``setSelection`()
  setSelection(selection: string[]): void

  Sets a list of items to be added to the selection set.

  Parameters

  > selection: string[]

  Returns: void

`Bcf.BCFViewpoint.``setSelectionNodes`()
  setSelectionNodes(selection: `BcfNode`[]): void

  Sets a list of items to be added to the selection set.

  Parameters

  > selection: `BcfNode`[]

  Returns: void

`Bcf.BCFViewpoint.``setVisibilityExceptionNodes`()
  setVisibilityExceptionNodes(visibilityExceptions: `BcfNode`[]): void

  Sets the visibility exceptions. These nodes will be shown or hidden based on the default visibility setting.

  Parameters

  > visibilityExceptions: `BcfNode`[]

  > > Array of BcfNodes corresponding to components.

  Returns: void

`Bcf.BCFViewpoint.``setVisibilityExceptions`()
  setVisibilityExceptions(visibilityExceptions: string[]): void

  Sets the visibility exceptions. These nodes will be shown or hidden based on the default visibility setting.

  Parameters

  > visibilityExceptions: string[]

  > > Array of GenericIds corresponding to components.

  Returns: void

`static Bcf.BCFViewpoint.``createViewpoint`()

  static

  createViewpoint(viewer: `IWebViewer`, viewpointFilename: string, markupView: (None | `MarkupView`)?): Promise

  Parameters

  > viewer: `IWebViewer`

  > viewpointFilename: 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...