Class VisualisationFactoryHelper

Helper methods for ICamApiVisualisationFactory.

Inheritance

object

VisualisationFactoryHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class VisualisationFactoryHelper

Methods

CreateGizmo(ComWrapper<ICamApiVisualisationFactory>, ComWrapper<ICamApiViewManager>, ComWrapper<ICamApiVisualObject>?)

Create a move/rotate gizmo in the manager's scene, returned as ICamApiGizmo directly.

Declaration

public static ComWrapper<ICamApiGizmo> CreateGizmo(this ComWrapper<ICamApiVisualisationFactory> factoryCom, ComWrapper<ICamApiViewManager> managerCom, ComWrapper<ICamApiVisualObject>? parent = null)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom
ComWrapper<ICamApiViewManager>	managerCom
ComWrapper<ICamApiVisualObject>	parent

Returns

Type	Description
ComWrapper<ICamApiGizmo>

CreateMeshBuilder(ComWrapper<ICamApiVisualisationFactory>)

Create an empty mesh builder for bulk geometry construction.

Declaration

public static ComWrapper<ICamApiMeshBuilder> CreateMeshBuilder(this ComWrapper<ICamApiVisualisationFactory> factoryCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom

Returns

Type	Description
ComWrapper<ICamApiMeshBuilder>

CreatePreview(ComWrapper<ICamApiVisualisationFactory>, ComWrapper<ICamApiViewManager>, ComWrapper<ICamApiVisualObject>?)

Create a renderable visual object in the manager's scene (alias of CreateVisualObject).

Declaration

public static ComWrapper<ICamApiVisualObject> CreatePreview(this ComWrapper<ICamApiVisualisationFactory> factoryCom, ComWrapper<ICamApiViewManager> managerCom, ComWrapper<ICamApiVisualObject>? parent = null)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom
ComWrapper<ICamApiViewManager>	managerCom
ComWrapper<ICamApiVisualObject>	parent

Returns

Type	Description
ComWrapper<ICamApiVisualObject>

CreateViewManager(ComWrapper<ICamApiVisualisationFactory>)

Create a new, empty view manager (its own scene + viewports).

Declaration

public static ComWrapper<ICamApiViewManager> CreateViewManager(this ComWrapper<ICamApiVisualisationFactory> factoryCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom

Returns

Type	Description
ComWrapper<ICamApiViewManager>

CreateViewPort(ComWrapper<ICamApiVisualisationFactory>, ComWrapper<ICamApiViewManager>, long)

Create a viewport that renders the given manager's scene, hosted in ParentWnd.

Declaration

public static ComWrapper<ICamApiViewPort> CreateViewPort(this ComWrapper<ICamApiVisualisationFactory> factoryCom, ComWrapper<ICamApiViewManager> managerCom, long parentWnd)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom
ComWrapper<ICamApiViewManager>	managerCom
long	parentWnd

Returns

Type	Description
ComWrapper<ICamApiViewPort>

CreateVisualObject(ComWrapper<ICamApiVisualisationFactory>, ComWrapper<ICamApiViewManager>, ComWrapper<ICamApiVisualObject>?)

Create a renderable visual object (meshes, polylines, hotspots) in the manager's scene. Returns its scene node; reach content/interactivity via AsRenderable / AsInteractive.

Declaration

public static ComWrapper<ICamApiVisualObject> CreateVisualObject(this ComWrapper<ICamApiVisualisationFactory> factoryCom, ComWrapper<ICamApiViewManager> managerCom, ComWrapper<ICamApiVisualObject>? parent = null)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom
ComWrapper<ICamApiViewManager>	managerCom
ComWrapper<ICamApiVisualObject>	parent

Returns

Type	Description
ComWrapper<ICamApiVisualObject>

EnumerateVisualObjects(ComWrapper<ICamApiVisualisationFactory>, ComWrapper<ICamApiViewManager>)

Enumerate the manager's visual objects depth-first. Each yielded wrapper is disposed once enumeration advances, so do NOT wrap the loop variable in a using; copy out what you need before the next iteration.

Declaration

public static IEnumerable<ComWrapper<ICamApiVisualObject>> EnumerateVisualObjects(this ComWrapper<ICamApiVisualisationFactory> factoryCom, ComWrapper<ICamApiViewManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom
ComWrapper<ICamApiViewManager>	managerCom

Returns

Type	Description
IEnumerable<ComWrapper<ICamApiVisualObject>>

RemoveVisualObject(ComWrapper<ICamApiVisualisationFactory>, ComWrapper<ICamApiViewManager>, ComWrapper<ICamApiVisualObject>)

Remove a single visual object from the manager's scene (does not cascade to grouped children).

Declaration

public static void RemoveVisualObject(this ComWrapper<ICamApiVisualisationFactory> factoryCom, ComWrapper<ICamApiViewManager> managerCom, ComWrapper<ICamApiVisualObject> obj)

Parameters

Type	Name	Description
ComWrapper<ICamApiVisualisationFactory>	factoryCom
ComWrapper<ICamApiViewManager>	managerCom
ComWrapper<ICamApiVisualObject>	obj