TViewParameters

The TViewParameters data structure defines the parameters of an OrcaFlex 3D View.

typedef struct {

int Size;

double ViewSize;

double ViewAzimuth;

double ViewElevation;

TVector ViewCentre;

int Height;

int Width;

COLORREF BackgroundColour;

BOOL DrawViewAxes;

BOOL DrawScaleBar;

BOOL DrawGlobalAxes;

BOOL DrawEnvironmentAxes;

BOOL DrawLocalAxes;

BOOL DrawOutOfBalanceForces;

BOOL DrawNodeAxes;

int GraphicsMode;

int FileFormat;

double ViewGamma;

TOrcFxAPIHandle RelativeToObjectHandle;

TOrcFxAPIHandle DisturbanceVesselHandle;

TVector2 DisturbancePosition;

int ShadedFillMode;

BOOL DrawNameLabels;

BOOL DrawConnections;

int LabelScale;

BOOL DrawOrigins;

BOOL MonochromeOutput;

BOOL AddDetailsToOutput;

int JpegCompressionQuality;

} TViewParameters;

Members

Size

Specifies the size, in bytes, of this data structure. Set this member to sizeof(TViewParameters) before calling a function with a TViewParameters parameter.

ViewSize, ViewAzimuth, ViewElevation and ViewGamma

Determines the size and orientation of the view. For more details please refer to the OrcaFlex documentation.

ViewCentre

Defines the 3D global coordinates of the point that is shown at the centre of the view.

RelativeToObjectHandle

The view settings will be relative to this object. Use NULL for relative to 'Global'.

Height and Width

BackgroundColour

Defines the background colour of the view. This member can be set using the RGB Windows macro.

DrawViewAxes, DrawScaleBar, DrawGlobalAxes, DrawEnvironmentAxes, DrawLocalAxes, DrawOutOfBalanceForces, DrawNodeAxes, DrawNameLabels, DrawConnections and DrawOrigins

Determines whether the view axes, scale bar etc. are drawn in the view. For more details please refer to the OrcaFlex documentation.

GraphicsMode

Determines which OrcaFlex graphics mode is used to produce the system view. Can be either gmWireFrame or gmShaded.

FileFormat

Determines which bitmap file format is output by calls to C_SaveModel3DViewBitmapMem and C_SaveModel3DViewBitmapToFile. Can be one of the following: bffWindowsBitmap, bffPNG, bffGIF, bffJPEG, bffPDF or bffRGB. This member is ignored by C_CreateModel3DViewBitmap since that function creates a bitmap handle rather than a file or byte array.

When bffRGB is specified, the pixel data is returned as a packed array of RGB values, with 8 bit colour channels. Thus the pixel data has size equal to Height * Width * 3.

DisturbanceVesselHandle

Specifies that the sea surface will be drawn as if disturbed by the presence of this vessel. Use NULL to view the undisturbed sea surface. For more details please refer to the OrcaFlex documentation.

DisturbancePosition

Specifies the position on the sea surface at which the disturbance due to a vessel will be computed. This is only used if the sea state RAOs are being interpolated on direction and period only (see the OrcaFlex documentation for more details).

ShadedFillMode

Determines which fill mode is used for shaded graphics. Can be either fmSolid or fmMesh.

LabelScale

A percentage value that determines the size of name labels and label shape text.

MonochromeOutput

AddDetailsToOutput

When set to TRUE, 3D views are drawn with a text label identifying the program version and giving details of the model's latest loaded or saved file.

JpegCompressionQuality

A value between 1 and 100 that determines the quality of JPEG files. Lower values have poorer visual quality, but greater compression (i.e. smaller file size). Higher values have better visual quality, but less compression (i.e. larger file size). If a negative value is specified then a default value of 95 is used.