ObjectDCL Banner

BlockView_LoadDwgToScale (Using Preset Views) Method

Description

This method loads an external drawing file into the control at an exact scale for display just as the BlockView control displays other blocks. This method will allow the camera viewing angle to be set by a standard preset (SW, NW, Top, Front, etc.)

To set the exact scale the zoom factor argument can be calculated as Units per Pixel. So for example a 10 inch by 10 inch block displayed with a value of 0.5 will display about 20 pixels by 20 pixels (+ or - one pixel) in size in the control.

ZoomFactor = Actual Units / ScreenUnits.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.
sDwgFileName
String identifying the drawing file name.
nPresetView
Integer identifying the preset view. The valid values are:
  • 0 (Top)
  • 1 (Bottom)
  • 2 (Right)
  • 3 (Left)
  • 4 (Front)
  • 5 (Back)
  • 6 (South-West - isometric)
  • 7 (South-East - isometric)
  • 8 (North-West - isometric)
  • 9 (North-East - isometric)
rZoomFactor
Real identifying the zoom factor to apply.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found or does not support this function.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_BlockView_LoadDwgToScale 
		MyControlReference [as Reference]
		sDwgFileName [as String]
		[Optional] nPresetView [as Integer]
		[Optional] rZoomFactor [as Real]
	)

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_BlockView_LoadDwgToScale
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		sDwgFileName [as String]
		[Optional] nPresetView [as Integer]
		[Optional] rZoomFactor [as Real]
	)

Applies For

BlockView.

Example

CopyCode imageCopy Code
; Load the drawing and set the camera from the top
(Odcl_BlockView_LoadDwgToScale MyProject_MyForm_MyControl "Structural - Metric.dwg" 0)