Navigation: Scripting Reference Manual > Data Structures > T_SURFVISUALIZE

 

T_SURFVISUALIZE

 

Contact Us: fredsupport@photonengr.com

 

Description

Data structure for the visualization attributes of a surface.

 

Definition

Type T_SURFVISUALIZE

tesselateSizeX As Double
tesselateSizeY As Double
tesselateSizeZ As Double
tesselateScaleX As Double
tesselateScaleY As Double
tesselateScaleZ As Double
axesOriginX As Double
axesOriginY As Double
axesOriginZ As Double
axesNegLengthX As Double
axesNegLengthY As Double
axesNegLengthZ As Double
axesPosLengthX As Double
axesPosLengthY As Double
axesPosLengthZ As Double
opacity As Double
drawMode As String
AmbientR As Integer
AmbientG As Integer
AmbientB As Integer
DiffuseR As Integer
DiffuseG As Integer
DiffuseB As Integer
SpecularR As Integer
SpecularG As Integer
SpecularB As Integer
WireframeR As Integer
WireframeG As Integer
WireframeB As Integer
shine As Integer
isAxesOriginAbsolute As Boolean
isAxesLengthAbsolute As Boolean
axesXR As Integer
axesXG As Integer
axesXB As Integer
axesYR As Integer
axesYG As Integer
axesYB As Integer
axesZR As Integer
axesZG As Integer
axesZB As Integer
drawCoordAxes As Boolean
drawLocal As Boolean
drawGlobal As Boolean
localR As Integer
localG As Integer
localB As Integer
globalR As Integer
globalG As Integer
globalB As Integer

End Type

 

Members

tesselateSizeX (Double)

The size of the tesselation in X

 

tesselateSizeY (Double)

The size of the tesselation in Y

 

tesselateSizeZ (Double)

The size of the tesselation in Z


tesselateScaleX (Double)

The size of the tesselation scale factor in X

 

tesselateScaleY (Double)

The size of the tesselation scale factor in Y

 

tesselateScaleZ (Double)

The size of the tesselation scale factor in Z

 

axesOriginX (Double)

The location in X of the Coordinate Axes origin

 

axesOriginY (Double)

The location in Y of the Coordinate Axes origin

 

axesOriginZ (Double)

The location in Z of the Coordinate Axes origin

 

axesNegLengthX (Double)

The length of the negative axis in the X direction

 

axesNegLengthY (Double)

The length of the negative axis in the Y direction

 

axesNegLengthZ (Double)

The length of the negative axis in the Z direction

 

axesPosLengthX (Double)

The length of the positive axis in the X direction

 

axesPosLengthY (Double)

The length of the positive axis in the Y direction

 

axesPosLengthZ (Double)

The length of the positive axis in the Z direction

 

opacity (Double)

Opacity of the entity. May be a value from 0.0 to 1.0.

 

drawMode (String)

Mode used to draw the entity. May be one of the following: "flat", "smooth", "wire", or "point".

 

AmbientR (Integer)

Red component of the ambient color

 

AmbientG (Integer)

Green component of the ambient color

 

AmbientB (Integer)

Blue component of the ambient color

 

DiffuseR (Integer)

Red component of the diffuse color

 

DiffuseG (Integer)

Green component of the diffuse color

 

DiffuseB (Integer)

Blue component of the diffuse color

 

SpecularR (Integer)

Red component of the specular color

 

SpecularG (Integer)

Green component of the specular color

 

SpecularB (Integer)

Blue component of the specular color

 

WireframeR (Integer)

Red component of the wireframe color

 

WireframeG (Integer)

Green component of the wireframe color

 

WireframeB (Integer)

Blue component of the wireframe color

 

shine (Integer)

Amount of shine on the FRED entity. May be an integer value between 0 and 128.

 

isAxesOriginAbsolute (Boolean)

If True, expresses the origin of the axes relative to the global origin. If False, expresses the origin of the axes relative to the object's trimming volume.

 

isAxesLengthAbsolute (Boolean)

If True, expresses the length of each axis relative to the global coordinate system. If False, expresses the length of each axis relative to the trimming volume.

 

axesXR (Integer)

Red component of the X coordinate axis color

 

axesXG (Integer)

Green component of the X coordinate axis color

 

axesXB (Integer)

Blue component of the X coordinate axis color

 

axesYR (Integer)

Red component of the Y coordinate axis color

 

axesYG (Integer)

Green component of the Y coordinate axis color

 

axesYB (Integer)

Blue component of the Y coordinate axis color

 

axesZR (Integer)

Red component of the Z coordinate axis color

 

axesZG (Integer)

Green component of the Z coordinate axis color

 

axesZB (Integer)

Blue component of the Z coordinate axis color

 

drawCoordAxes (Boolean)

Determines if the local coordinate axes are to be drawn. Set to True if you want them drawn, False otherwise.

 

drawLocal (Boolean)

Determines if the local trimming volume is to be drawn. Set to True if you want it drawn, False otherwise.

 

drawGlobal (Boolean)

Determines if the global trimming volume is to be drawn. Set to True if you want it drawn, False otherwise.

 

localR (Integer)

Red component of the local trimming volume color

 

localG (Integer)

Green component of the local trimming volume color

 

localB (Integer)

Blue component of the local trimming volume color

 

globalR (Integer)

Red component of the global trimming volume color

 

globalG (Integer)

Green component of the global trimming volume color

 

globalB (Integer)

Blue component of the global trimming volume color

 

 

Remarks

All RGB color components take on values from 0 to 255.

The tessellation size is an absolute size.  A value of 0 indicates to use a default size.

The tessellation scale is a scale factor on the tessellation size.

The coordinate axes origin and lengths can be specified in either absolute local coordinates or relative local coordinates.  Absolute coordinates are in the local coordinate system of the surface.  Relative coordinates are relative to the surface's local trimming volume size and location.

Opacity can take on values from 0.0 (completely transparent) to 1.0 (completely opaque).

Shine can take on values from 0 (no shine) to 128 (max amount of shine).

DrawMode specifies how the surface will be drawn and can take on one of the following values: "Flat", "Smooth", "Wire", or "Point".

 

Used as Parameter in

GetSurfVisualize

InitSurfVisualize

SetSurfVisualize

Examples

Surfaces

 

 

 

 

 

Copyright © Photon Engineering, LLC