Window3DDefaults struct

From Solid Graphics Wiki

(Redirected from Window3ddefaults)
Jump to: navigation, search
Window3DDefaults struct
Namespace: SKL3D
Base type: (None)
Include: Skl3DWindow.h
Lib (Release): SKL.lib
Lib (Debug): SKL_D.lib

The Window3DDefaults struct is a type holding the default values for the Window3D class. The Window3D class' constructor uses the defaultSettings (which is of Window3DDefaults struct type) field values to initialize the Window3D class objects.

The Window3DDefaults struct is the type of the defaultSettings static variable of the Window3D class.


Constructors

The struct has no constructors.

Fields

Field name Type Description
windowFont String Specifies location of texture font resource used for default Window3D object font. This can be either a file name (of usually PNG file) or string in format "RESOURCE:(idFont) (idFontSizes)", where (id) is integer identifier of binary memory image resource attached to application's EXE file, and (idFontSizes) is integer number of binary resource containing 256 float values representing the character widths. Default value of this field is "" (empty string) - which causes the Window3D object to have no default font.
shareDisplayLists bool Flag telling whether to share OpenGL display lists (true) between multiple rendering contexts or not (false). Default is true.
useDoubleBuffer bool Flag telling whether to use OpenGL double buffering (true) or not (false). Default is true.
useOrthoProjection bool Flag telling whether to initially use ortho projection (true) when window is created or not (false). Default is false.
useFreePerspectiveZoom bool Flag telling whether zoom mode in perspective projection will be always view window centered (false) or whether zoom window can be specified anywhere on the window screen (true). Default is true. When zoom rectangle can be freely placed on the view window then some parts of the scene might be not rendered in the view after the view is zoomed in - even if they were in the zoom selection rectangle. This is because of the nature of the perspective projection. The Window3D class zooms onto the area at the target position distance - this might cause objects which are closer to the eye position to not be displayed if the zoom selection rectangle is away from the center of the window.
ensureContext bool This flags tells the Window3D class object whether to call ::wglMakeCurrent in each it's method calls which change the view projection (true) or not (false). Default is true.
interactionMode int Initial view interaction mode to use when a Window3D object is created. Default value is Window3D::ImNone.
manipulationMode int Initial view manipulation mode to use when a Window3D object is created. Default value is Window3D::MmSceneAndObjects.
antialiasingQuality int Initial view's antialiasing quality setting. Default value is 0.
displayOptions int Initial view's display options. Defaul value is 0 (none).
floorNavigation bool The flags tells whether to initialize Window3D object with floor navigation mode (true) or not (false). Default is true.
floorPlane Plane Default floor plane normal to use for the floor navigation mode. Default value is cYAxis.
floorXDirection Vector Default floor plane's X axis to use in the floor navigation mode. Default value is cXAxis.
floorGridPixels int Minimum number of screen pixels between displayed floor plane grid lines at target position distance. Default value is 15. This settings is only used when Window3D::DisplayFloorPlane method is not overrided an therefore used to display the floor plane, and the RE_DISPLAY_FLOOR_PLANE bit of the display options is set to 1.
floorSize float This is relative value which can be used to enlarge or shrink floor plane displayed by the Window3D::DisplayFloorPlane method. Default value is 1.0f.
animationMode bool Flag indicating whether the window initiallly starts in animation mode (true) or not (false). Default is false.
frameBufferClearFlags unsigned int Value used by Window3D object when calling ::glClear OpenGL function. Default value of this field is GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT.
nearClipDistance float Near clipping distance settings for viewing frustum. If set to -FLT_MAX then the near clip distance of viewing frustum is set to eye position distance to the sum of bounding boxes set by SetSceneBoundingBoxInfo method and SetDisplayBoundingBoxInfo method. Default value is -FLT_MAX.
farClipDistance float Far clipping distance settings for viewing frustum. If set to -FLT_MAX then the far clip distance of viewing frustum is set to eye position distance to farther edge of the sum of bounding boxes set by SetSceneBoundingBoxInfo method and SetDisplayBoundingBoxInfo method. Default value is -FLT_MAX.
nearClipDistanceRatio float This value is used to calculate near clip distance in perspective projection if Window3D object's nearClipDistance is set to -FLT_MAX. In that case the near clip distance is set to sceneRadius / nearClipDistanceRatio if eye position is inside scene bounding box or scene bounding box is closer to the eye position than the sceneRadius / nearClipDistanceRatio value. Default value of this field is 1000.0f.
clearDepth float This value is used to clear the OpenGL depth buffer when view's framebuffer is cleared for rendering next frame. Default value of this field is 1.0f.
selectionBufferSize int Size allocated for OpenGL selection buffer when OpenGL based selection is used. Default is 512.
pickingVolumeSize float Picking area specified in pixels used for object selection. Default is 3.0f
packAlignment int Value used for OpenGL's GL_PACK_ALIGNMENT state variable. Default value is 4.
unpackAlignment int Value used for OpenGL's GL_UNPACK_ALIGNMENT state variable. Default value is 4.
viewAngleY float Initial vertical view angle in degrees to use when the view is created. Default value is 45.0.
maxPrintResolution int Maximum size of either of the dimensions of internal bitmap used for printing the view by printer. Default value of this field is 2048.
unitIdentifier CoordinateUnit::UnitId Default unit identifiers used by Window3D objects. Default value is SKL3D::CoordinateUnit::Meter.
unitsPerMeter double Units per meter specified for the unitIdentifier field. Default is 1.0f.
zoomFactor float Zoom factor used when Window3D::ZoomIn or Window3D::ZoomOut method is called. Default value is 1.4f.

Methods

The Window3DDefaults struct has no public methods.

Operators

The Window3DDefaults struct has no public operators.

See Also

   


SolidKit Library Documentation

Personal tools