Navigation: Scripting Reference Manual > Data Structures > T_ENTITYARRAY

 

T_ENTITYARRAY

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure for defining arrays in FRED.

 

Definition

Type T_ENTITYARRAY

aXcellSpacing As Double

aYcellSpacing As Double

aZcellSpacing As Double

bXcellSpacing As Double

bYcellSpacing As Double

bZcellSpacing As Double

aMinIndex As Long

aMaxIndex As Long

bMinIndex As Long

bMaxIndex As Long

aNthCellOutline As Long

bNthCellOutline As Long

aNthCellCenter As Long

bNthCellCenter As Long

aNthRowColOutline As Long

bNthRowColOutline As Long

aNthCellContents As Long

bNthCellContents As Long

arrayOutlineR As Integer

arrayOutlineG As Integer

arrayOutlineB As Integer

cellOutlineR As Integer

cellOutlineG As Integer

cellOutlineB As Integer

cellCenterR As Integer

cellCenterG As Integer

cellCenterB As Integer

rowColOutlineR As Integer

rowColOutlineG As Integer

rowColOutlineB As Integer

drawArrayOutline As Boolean

drawCellOutlines As Boolean

drawCellCenters As Boolean

drawRowColOutlines As Boolean

drawCellContents As Boolean

End Type

 

Members

aXcellSpacing

The X component of the spacing vector in the A direction

 

aYcellSpacing

The Y component of the spacing vector in the A direction

 

aZcellSpacing

The Z component of the spacing vector in the A direction

 

bXcellSpacing

The X component of the spacing vector in the B direction

 

bYcellSpacing

The Y component of the spacing vector in the B direction

 

bZcellSpacing

The Z component of the spacing vector in the B direction

 

aMinIndex

The minimum cell index in the A direction. FRED creates the array with (aMaxIndex – aMinIndex + 1) elements in the A direction.

 

aMaxIndex

The maximum cell index in the A direction. FRED creates the array with (aMaxIndex – aMinIndex + 1) elements in the A direction.

 

bMinIndex

The minimum cell index in the B direction. FRED creates the array with (aMaxIndex – aMinIndex + 1) elements in the A direction.

 

bMaxIndex

The maximum cell index in the B direction. FRED creates the array with (aMaxIndex – aMinIndex + 1) elements in the A direction.

 

aNthCellOutline

The Nth cell outline to be drawn in the A direction. The default is 1; if drawCellOutlines is set to True, the outline of every cell in the A direction is drawn.

 

bNthCellOutline

The Nth cell outline to be drawn in the B direction. The default is 1; if drawCellOutlines is set to True, the outline of every cell in the B direction is drawn.

 

aNthCellCenter

The Nth cell center to be drawn in the A direction. The default is 1; if drawCellCenters is set to True, the center of every cell in the A direction is drawn.

 

bNthCellCenter

The Nth cell center to be drawn in the B direction. The default is 1; if drawCellCenters is set to True, the center of every cell in the B direction is drawn.

 

aNthRowColOutline

The Nth row/column outline to be drawn in the A direction. The default is 1; if drawRowColOutlines is set to True, the outline of every cell in the A direction is drawn.

 

bNthRowColOutline

The Nth row/column outline to be drawn in the B direction. The default is 1; if drawRowColOutlines is set to True, the outline of every cell in the B direction is drawn.

 

aNthCellContents

The Nth cell contents to be drawn in the A direction. The default is 1; if drawCellContents is set to True, every element of the array in the A direction is drawn.

 

bNthCellContents

The Nth cell contents to be drawn in the B direction. The default is 1; if drawCellContents is set to True, every element of the array in the B direction is drawn.

 

arrayOutlineR

The red component of the color of the array outline box.

 

arrayOutlineG

The green component of the color of the array outline box.

 

arrayOutlineB

The Blue component of the color of the array outline box.

 

cellOutlineR

The red component of the color of the cell outline box.

 

cellOutlineG

The green component of the color of the cell outline box.

 

cellOutlineB

The blue component of the color of the cell outline box.

 

cellCenterR

The red component of the color of the cell center marker.

 

cellCenterG

The green component of the color of the cell center marker.

 

cellCenterB

The blue component of the color of the cell center marker.

 

rowColOutlineR

The red component of the color of the row/column outline box.

 

rowColOutlineG

The green component of the color of the row/column outline box.

 

rowColOutlineB

The blue component of the color of the row/column outline box.

 

drawArrayOutline

When set to True, FRED draws the outline bounding box around the array in the color specified by (arrayOutlineR, arrayOutlineG, arrayOutlineB). The default is True.

 

drawCellOutlines

When set to True, FRED draws the outline bounding box around cell of the array in the color specified by (cellOutlineR, cellOutlineG, cellOutlineB). The default is False.

 

drawCellCenters

When set to True, FRED draws a marker indicting the center of each cell in the array in the color specified by (cell CenterR, cellCenterG, cellCenterB). The default is False.

 

drawRowColOutlines

When set to True, FRED draws a bounding box around each row/column of the array in the color specified by (rowColOutlineR, rowColOutlineG, rowColOutlineB). The default is False.

 

drawCellContents

When set to True, FRED draws each element of the array. The default is False. (You should use caution with this setting if your array has a large number of cells because it can overwhelm your video card.)

 

 

Used as Parameter in

InitEntityArray

GetEntityArray

SetEntityArray

Examples

Importance Samples

 

 

 

 

 

Copyright © Photon Engineering, LLC