Click or drag to resize

IBuilder Interface

The top level application interface. This class provides services which apply to the whole application and are not specific to the currently loaded document.

Namespace: Demo3D.Visuals
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 19.00.00
Syntax
C#
public interface IBuilder : IPackageTarget

The IBuilder type exposes the following members.

Properties
 NameDescription
Public propertyBackgroundTaskViewer Interface for adding background tasks to the status bar view.
Public propertyCatalogManager 
Public propertyCompanyDataDirectory 
Public propertyControlPanelManager Interface for the Control Panel Plugin
Public propertyCoSimulationMaster The co-simulation master.
Public propertyDispatchThreadId 
Public propertyDisplaySettings Interaction with the GUI to enable/disable things like ShowDirectionArrows.
Public propertyDocument 
Public propertyDocumentsDirectory 
Public propertyEditionDataDirectory 
Public propertyInstallPath 
Public propertyInvokeRequired 
Public propertyMessageBoxCaption 
Public propertyModelInvokeRequired Essentially just a check if the current thread is the model thread, but makes no guarantees that it will remain the model thread afterwards.

If the model is not currently running, or is running in the GUI thread, this just returns InvokeRequired.

Public propertyOptions 
Public propertyPackageFeed 
Public propertyPackageTargetName The name of the package target.
(Inherited from IPackageTarget)
Public propertyPageSettings 
Public propertyPrinterSettings 
Public propertyPrintMessagesEnabled 
Public propertyRenderManager Interface for adding additional renderers.
Public propertyRunMode 
Public propertyRunning 
Public propertySceneAnimation Access scene animation.
Public propertySelection 
Public propertySelectionManager 
Public propertyShowTooltips 
Public propertyUserData Application level user data storage.
Public propertyUserScriptsFolder 
Public propertyUserVars Application level user key-value pair storage.
Public propertyWebConfiguration Interface for the web app.
Top
Methods
 NameDescription
Public methodAddToSelection 
Public methodBeginInvoke 
Public methodClearSelection 
Public methodCreateVisual(VisualFactory) 
Public methodCreateVisual(VisualFactory, Vector3) 
Public methodCreateVisualWithoutFocus 
Public methodDeleteSelection 
Public methodExport(String, Boolean) 
Public methodExport(String, Visual, Boolean) 
Public methodForceRefreshPropertiesGrid Forcibly refreshes Properties Grid even when it is being edited.
Public methodGetPackageManager Gets the default package manager for the target if no options are specified. Otherwise returns a new package manager.
(Inherited from IPackageTarget)
Public methodInstantiateAsset(Asset) Instantiates the given asset at the location of the cursor.
Public methodInstantiateAsset(Asset, Vector3) Instantiates the given asset at the given world co-ordinates.
Public methodInvoke 
Public methodModelBeginInvoke(Action) Invoke an action on the Demo3D model thread.
Public methodModelBeginInvoke(ActionObject, Object) Invoke an action on the Demo3D model thread.
Public methodNotifyAfterFileImported Call this to notify interested listeners to examine (re)imported CAD.
Public methodRefreshPropertiesGrid Refreshes the Properties Grid unless it's currently being edited. This is the recommended API for most situations.
Public methodReset 
Public methodSaveOptions 
Public methodSaveWorldEdits Display a confirmation dialog to prompt saving edits made to the model.
Public methodSelect 
Public methodShowFeedManager Show the package feed manager.
Public methodSnapshotColorData Get the color data as an array or image
Public methodSnapshotDepthData Get the depth data as an array or image
Public methodStartVideoRecording Start recording the scene, opens a dialog to set the file path, end with StopVideoRecording
Public methodStartVideoRecording(Demo3DMovieExportFormat) Start recording the scene, end with StopVideoRecording
Public methodStartVideoRecording(String) Start recording the scene, end with StopVideoRecording
Public methodStopVideoRecording Stop recording the scene
Top
Events
 NameDescription
Public eventAfterCatalogClosedEventHandler called after a Catalog is unloaded.
Public eventAfterCatalogLoadedEventHandler called after a Catalog is loaded, first parameter is the Catalog as an Object, and second is a CatalogEventArgs as a EventArgs.
Public eventAfterCSharpCodeCompiledEventHandler called after some C# code is compiled.
Public eventAfterDocumentLoadedEventHandler called after a New Document is loaded, first parameter is the IBuilder as an Object, and second is null.
Public eventAfterDocumentSavedEventHandler called after a Document is saved, first parameter is the IBuilder as an Object, and second is null.
Public eventAfterFileImportedEventHandler called after a File is imported, first parameter is the IBuilder as an Object, and second is a ImportEventArgs as a EventArgs.
Public eventAfterNewDocumentEventHandler called after a New Document is created, first parameter is the IBuilder as an Object, and second is null.
Public eventAppClosingEventHandler called when the app is closing.
Public eventBeforeCatalogClosedEventHandler called before a Catalog is unloaded, first parameter is the Catalog as an Object, and second is a CatalogEventArgs as a EventArgs.
Public eventBeforeCatalogLoadedEventHandler called before a Catalog is loaded.
Public eventBeforeDocumentLoadedEventHandler called before a New Document is loaded, first parameter is the IBuilder as an Object, and second is null.
Public eventBeforeDocumentSavedEventHandler called before a Document is saved, first parameter is the IBuilder as an Object, and second is null.
Public eventBeforeNewDocumentEventHandler called before a New Document is created, first parameter is the IBuilder as an Object, and second is null.
Public eventDocumentReadyForRender Called when a document is ready to render for the first time.
Top
Extension Methods
See Also