Unit GridGeneration

DescriptionUsesClasses, Interfaces, Objects and RecordsFunctions and ProceduresTypesConstantsVariables

Description

The purpose of GridGeneration is to supply the GenerateGrid function which is used to create the grid based on TScreenObjects.

Uses

Overview

Functions and Procedures

function GenerateGrid(out ErrorMessage: string; const SpecifyGridAngle: boolean; const SpecifiedGridAngle: real; const SmoothColumns, SmoothRows, SmoothLayers: boolean; const SmoothingCriterion: double): boolean;
function GenGridErrorMessage: string;

Description

Functions and Procedures

function GenerateGrid(out ErrorMessage: string; const SpecifyGridAngle: boolean; const SpecifiedGridAngle: real; const SmoothColumns, SmoothRows, SmoothLayers: boolean; const SmoothingCriterion: double): boolean;

GenerateGrid is used to create the grid based on TScreenObjects.

Parameters
ErrorMessage
specifies the reason why grid generation failed. Ignore ErrorMessage if GenerateGrid returns True.
SpecifyGridAngle
specifies whether SpecifiedGridAngle should be used as the grid angle or whether SpecifiedGridAngle should be ignored. Set SpecifyGridAngle to True to use SpecifiedGridAngle.
SpecifiedGridAngle
is the grid angle that will be used in generating the grid. SpecifiedGridAngle is only used when SpecifyGridAngle is True.
SmoothColumns
says whether the grid should be modified so that the ratio between the widths of adjacent columns is less than SmoothingCriterion. If SmoothColumns is True, the grid will be modified in this way.
SmoothRows
says whether the grid should be modified so that the ratio between the widths of adjacent rows is less than SmoothingCriterion. If SmoothRows is True, the grid will be modified in this way.
SmoothLayers
says whether the grid should be modified so that the ratio between the widths of adjacent layers is less than SmoothingCriterion. If SmoothLayers is True, the grid will be modified in this way.
SmoothingCriterion
is the desired ratio between the widths of adjacent columns, rows, or layers. SmoothingCriterion is ignored if SmoothColumns, SmoothRows, and SmoothLayers are all false.
Returns

GenerateGrid returns true if the grid was generated. If a grid was not created, GenerateGrid returns false and ErrorMessage gives the reason why grid generation failed.

function GenGridErrorMessage: string;
 

Generated by PasDoc 0.12.1 on 2013-05-13 15:41:42