ObjectDCL Banner

BlockView_GetViewInfo Method

Description

This method will return the block view display information. Specifically, it returns a complex list containing the target position, the camera position, the up director vector, the camera field width and height and is the view being displayed in perspective.

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.

Return Values

Returns the following according to the situation:

  • List organized as follows: 
    (
	(
		targetX
		targetY
		targetZ
	)
	(
		cameraX
		cameraY
		cameraZ
	)
	(
		upVectorX
		upVectorY
		upVectorZ
	)
	fieldWidth
	fieldHeight
	isPerspective
)
  • 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_GetViewInfo 
		MyControlReference [as Reference]
	)

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_GetViewInfo
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
	)

Applies For

BlockView.

Example

CopyCode imageCopy Code
; Get information about the view
(Odcl_BlockView_GetViewInfo MyProject_MyForm_MyControl)