Navigation: Scripting Reference Manual > Data Structures > T_BACKGROUNDGRID

 

T_BACKGROUNDGRID

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure for the Background Grid of a Visualization window.

 

Definition

Type T_BACKGROUNDGRID

xmin As Double

ymin As Double

zmin As Double

xmax As Double

ymax As Double

zmax As Double

xdiv As Long

ydiv As Long

zdiv As Long

FrontDisplay As String

BackDisplay As String

LeftDisplay As String

RightDisplay As String

TopDisplay As String

BottomDisplay As String

drawFront As Boolean

drawBack As Boolean

drawLeft As Boolean

drawRight As Boolean

drawTop As Boolean

drawBottom As Boolean

drawAxisFront As Boolean

drawAxisBack As Boolean

drawAxisLeft As Boolean

drawAxisRight As Boolean

drawAxisTop As Boolean

drawAxisBottom As Boolean

FaceFrontR As Integer

FaceFrontG As Integer

FaceFrontB As Integer

FaceBackR As Integer

FaceBackG As Integer

FaceBackB As Integer

FaceLeftR As Integer

FaceLeftG As Integer

FaceLeftB As Integer

FaceRightR As Integer

FaceRightG As Integer

FaceRightB As Integer

FaceTopR As Integer

FaceTopG As Integer

FaceTopB As Integer

FaceBottomR As Integer

FaceBottomG As Integer

FaceBottomB As Integer

AxisFrontR As Integer

AxisFrontG As Integer

AxisFrontB As Integer

AxisBackR As Integer

AxisBackG As Integer

AxisBackB As Integer

AxisLeftR As Integer

AxisLeftG As Integer

AxisLeftB As Integer

AxisRightR As Integer

AxisRightG As Integer

AxisRightB As Integer

AxisTopR As Integer

AxisTopG As Integer

AxisTopB As Integer

AxisBottomR As Integer

AxisBottomG As Integer

AxisBottomB As Integer

End Type

 

Members

xmin

Minimum extent of the background grid on the X axis.

 

ymin

Minimum extent of the background grid on the Y axis.

 

zmin

Minimum extent of the background grid on the Z axis.

 

xmax

Maximum extent of the background grid on the X axis.

 

ymax

Maximum extent of the background grid on the Y axis.

 

zmax

Maximum extent of the background grid on the Z axis.

 

xdiv

Number of divisions in the X direction of the background grid.

 

ydiv

Number of divisions in the Y direction of the background grid.

 

zdiv

Number of divisions in the Z direction of the background grid.

 

FrontDisplay, BackDisplay, LeftDisplay, RightDisplay, TopDisplay, BottomDisplay

Drawing type for each face. Available options are "Filled", "Lines", or "Points".

 

drawFront, drawBack, drawLeft, drawRight, drawTop, drawBottom

True if the face is to be drawn, False if it is not.

 

drawAxisFront, drawAxisBack, drawAxisLeft, drawAxisRight, drawAxisTop, drawAxisBottom

True if the Axis for that face is to be drawn, False if it is not.

 

FaceFrontR, FaceFrontG, FaceFrontB

Red, Green, and Blue components of the Front face color.

 

FaceBackR, FaceBackG, FaceBackB

Red, Green, and Blue components of the Back face color.

 

FaceLeftR, FaceLeftG, FaceLeftB

Red, Green, and Blue components of the Left face color.

 

FaceRightR, FaceRightG, FaceRightB

Red, Green, and Blue components of the Right face color.

 

FaceTopR, FaceTopG, FaceTopB

Red, Green, and Blue components of the Top face color.

 

FaceBottomR, FaceBottomG, FaceBottomB

Red, Green, and Blue components of the Bottom face color.

 

AxisFrontR, AxisFrontG, AxisFrontB

Red, Green, and Blue components of the Front axis color.

 

AxisBackR, AxisBackG, AxisBackB

Red, Green, and Blue components of the Back axis color.

 

AxisLeftR, AxisLeftG, AxisLeftB

Red, Green, and Blue components of the Left axis color.

 

AxisRightR, AxisRightG, AxisRightB

Red, Green, and Blue components of the Right axis color.

 

AxisTopR, AxisTopG, AxisTopB

Red, Green, and Blue components of the Top axis color.

 

AxisBottomR, AxisBottomG, AxisBottomB

Red, Green, and Blue components of the Bottom axis color.

 

Remarks

The Red, Green, and Blue color components range in value from 0 to 255.

 

Used as Parameter in

GetBackgroundGrid

SetBackgroundGrid

Examples

 

 

 

 

 

Copyright © Photon Engineering, LLC