Follow

How can I add a ClipPlane via Voxler automation?

This article contains a sample script for loading an existing VOXB file, adding a clip plane, and changing all the properties of the clip plane.


To run this script:

  1. Copy the script below, or click here to download the BAS file: ClipPlaneModule.bas.
  2. In a Windows Explorer window, navigate to C:\Program Files\Golden Software\Voxler 4\Scripter.
  3. Double click on Scripter.exe to launch Scripter.
  4. Press Ctrl+A to select all of the existing lines then press Delete.
  5. If you copied this script, press Ctrl+V to paste it into Scripter. If you downloaded it, click File | Open, select the BAS file from your downloads directory, and click Open.
  6. Click Script | Run to run the script.
     

*********

'********************************************************************************************
' ClipPlaneModule.bas
' This script loads an existing VOXB file and adds clip plane.
' It then changes all the properties of the clip plane.
'********************************************************************************************

' If Voxler is running, retrieve the current instance of Voxler.  Otherwise,
' create a new instance of Voxler.
Function VoxlerApplication()
   On Error Resume Next
   Set VoxlerApplication = GetObject(, "Voxler.Application")
   If Err.Number <> 0 Then
      Set VoxlerApplication = CreateObject("Voxler.Application")
   End If
   On Error GoTo 0
End Function

Sub Main
 'Retrieve running instance of Voxler or create a new instance of Voxler
  Dim VoxlerApp As Object
  Set VoxlerApp = VoxlerApplication()

 'Make Voxler visible
  VoxlerApp.Visible = True

 'Access CommandApi
  Set CommandApi = VoxlerApp.CommandApi

 'Create a new Voxler document
  CommandApi.Construct ("New")
  CommandApi.DoOnce()

 'Open an existing file
  CommandApi.Construct ("Open")
  CommandApi.Option ("Path", VoxlerApp.Path+"\Samples\Gold (ScatterPlot).voxb")
  CommandApi.DoOnce()

 'Add a clip plane
  CommandApi.Construct ("CreateModule")
  CommandApi.Option ("Type", "ClipPlane")
  CommandApi.Option ("AutoConnect", "True")
  CommandApi.Option ("SourceModule", "ScatterPlot")
  CommandApi.Do()

 'Alter the axis that the clip plane is showing - clip along X
  CommandApi.Construct ("ModifyModule")
  CommandApi.Option ("Module", "ClipPlane")
  CommandApi.Option ("ClipPlaneOrientation", "0")
  CommandApi.Do()

  Wait (2)

 'Alter the axis that the clip plane is showing - clip along Y
  CommandApi.Option ("ClipPlaneOrientation", "1")
  CommandApi.Do()

  Wait (2)

 'Alter the axis that the clip plane is showing - clip along Z
  CommandApi.Option ("ClipPlaneOrientation", "2")
  CommandApi.Do()

  Wait (2)

 'Alter the axis that the clip plane is showing - clip Custom angle
  CommandApi.Option ("ClipPlaneOrientation", "3")
  CommandApi.Do()
	 'Set the custom clip orientation
  	  CommandApi.Option ("ClipPlaneXDir", "1")
  	  CommandApi.Do()
  	  CommandApi.Option ("ClipPlaneYDir", "1")
  	  CommandApi.Do()
  	  CommandApi.Option ("ClipPlaneZDir", "2")
  	  CommandApi.Do()

 'Swap the clip plane direction
  CommandApi.Option ("ClipPlaneSwap", "True")
  CommandApi.Do()

 'Change the clip plane distance so it is not at the center of the map
  CommandApi.Option ("ClipPlaneDistance", "10")
  CommandApi.Do()

 'Show the clip plane dragger
  CommandApi.Option ("ClipPlaneDragger", "True")
  CommandApi.Do()


End Sub

 

Updated November 3, 2016

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.