BoundingBox

 

The BoundingBox module is created with the CreateModule command by setting the Type to BoundingBox. The properties of the BoundingBox are altered with the ModifyModule command. This is similar to the Network | Graphics Output | BoundingBox command.

 

Module Type

BoundingBox

 

Syntax

object.Construct(“CreateModule”)

object.Option(“SourceModule”, “data file name”)

object.Option(“Type”, “BoundingBox”)

object.Do() or object.DoOnce()

 

object.Construct(“ModifyModule”)

object.Option(“Module”, “BoundingBox”)

object.Option(“Option_Name”, “OptionValue”)

object.Do() or object.DoOnce()

 

Option Name

BoundingBoxColor

BoundingBoxLineWidth

BoundingBoxShowLabels

BoundingBoxFont

BoundingBoxLabelSize

BoundingBoxLabelColor

BoundingBoxLabelFormatType

BoundingBoxLabelFormatNumDigits

BoundingBoxLabelFormatPrefix

BoundingBoxLabelFormatPostfix

 

Example

This example shows how to open an existing Voxler file, add a bounding box, and alter the bounding box color.

 

Sub Main

 'Declares VoxlerApp as an object

  Dim VoxlerApp As Object

 

 'Creates an instance of the Voxler application object

 'and assigns it to the variable named "VoxlerApp"

  Set VoxlerApp = CreateObject("Voxler.Application")

 

 'Make Voxler visible

  VoxlerApp.Visible = True

 

 'Access CommandApi

  Set CommandApi = VoxlerApp.CommandApi

 

 'Open an existing file

  CommandApi.Construct ("Open")

  CommandApi.Option ("Path", VoxlerApp.Path+"\Samples\Vortex (VectorPlot).voxb")

  CommandApi.DoOnce()

 

 'Add a clip plane

  CommandApi.Construct ("CreateModule")

  CommandApi.Option ("Type", "BoundingBox")

  CommandApi.Option ("AutoConnect", "True")

  CommandApi.Option ("SourceModule", "TestLattice")

  CommandApi.Do()

 

 'Change the bounding box color to blue

  CommandApi.Construct ("ModifyModule")

  CommandApi.Option ("Module", "BoundingBox")

  CommandApi.Option ("BoundingBoxColor", "Blue")

  CommandApi.Do()

 

End Sub

 

Used by: CommandApi object, CreateModule, ModifyModule

 

 

See Also

Automation Model

Automation Example - BoundingBox