CFx SDK Documentation 2024 SP0
|
#include <GsInterfaceWrappers.h>
Base template for OdGsView class wrappers.
Corresponding C++ library: TD_Gs
<group OdGs_Classes>
Definition at line 151 of file GsInterfaceWrappers.h.
|
inline |
Constructor for the OdGsViewWrapper class. Sets the redirection view.
pRedirectionView | [in] Redirection view. |
Definition at line 163 of file GsInterfaceWrappers.h.
|
inline |
Adds the specified scene graph to the wrapped viewport object.
pSceneGraph | [in] Pointer to the root of the scene graph. |
pModel | [in] Pointer to the Model object to which all scene graph notifications are to be directed. |
Definition at line 783 of file GsInterfaceWrappers.h.
|
inline |
Returns anti-aliasing mode for current Viewport object.
Definition at line 1635 of file GsInterfaceWrappers.h.
|
inline |
Returns the back clip distance from the target of the wrapped viewport object. This method returns 0.0 if there is no redirection view.
Definition at line 649 of file GsInterfaceWrappers.h.
|
inline |
Returns current background object ID for the wrapped view. This method returns NULL if there is no redirection view.
Definition at line 1506 of file GsInterfaceWrappers.h.
|
inline |
Puts the wrapped viewport object into interactive state.
frameRateInHz | [in] Frames/second. |
Definition at line 935 of file GsInterfaceWrappers.h.
|
inline |
Thaws all Layer objects in the wrapped viewport object.
Definition at line 1059 of file GsInterfaceWrappers.h.
|
inline |
Returns the ClientViewInfo for the wrapped viewport object.
clientViewInfo | [out] Receives the ClientViewInfo. |
Definition at line 1437 of file GsInterfaceWrappers.h.
|
inline |
Clones the wrapped view object and returns a smart pointer to it. This method returns NULL view smart pointer valid if there is no redirection view.
cloneViewParameters | [in] If and only if true, view parameters will be cloned. |
cloneGeometry | [in] If and only if true, geometry will be cloned. |
Definition at line 1264 of file GsInterfaceWrappers.h.
|
inline |
Runs collision detection procedure inside the wrapped viewport object.
pInputList | [in] Pointer to the list of objects to check |
nInputListSize | [in] Size of the list of objects to check |
pCollisionWithList | [in] Pointer to the list of possible colliding objects |
nCollisionWithListSize | [in] Size of the list of possible colliding objects |
pCtx | [in] Pointer to the OdGsCollisionDetectionContext that provide additional Collision Detection options |
Definition at line 1613 of file GsInterfaceWrappers.h.
|
inline |
Retrieves a pointer to a device that owns the wrapped view. This method returns NULL if there is no redirection view.
Definition at line 173 of file GsInterfaceWrappers.h.
|
inline |
Translates the camera position and target by the specified Camera Coordinate dolly amount.
dollyVector | [in] Camera Coordinate dolly vector. |
Definition at line 1101 of file GsInterfaceWrappers.h.
|
inline |
Translates the camera position and target by the specified Camera Coordinate dolly amount.
xDolly | [in] Camera Coordinate X dolly amount. |
yDolly | [in] Camera Coordinate Y dolly amount. |
zDolly | [in] Camera Coordinate Z dolly amount. |
Definition at line 1119 of file GsInterfaceWrappers.h.
|
inline |
Enables or disables anti-aliasing in current Viewport object.
nLevel | [in] Anti-aliasing mode (set as 3 by default). Set as 0 to disable anti-aliasing. |
Definition at line 1626 of file GsInterfaceWrappers.h.
|
inline |
Enables default lighting for the wrapped view.
bEnable | [in] New default lighting state. |
lightType | [in] New default lighting type. |
Definition at line 1578 of file GsInterfaceWrappers.h.
|
inline |
Enables or disables ambient occlusion in current Viewport object.
bEnable | [in] Ambient occlusion mode (set as true by default). Set as false to disable ambient occlusion. |
Definition at line 1647 of file GsInterfaceWrappers.h.
|
inline |
Controls stereo viewing for the wrapped viewport object.
enable | [in] Controls stereo viewing. |
Definition at line 1311 of file GsInterfaceWrappers.h.
|
inline |
Removes the wrapped viewport object from the interactive state.
frameRateInHz | [in] Frames/second. |
Definition at line 947 of file GsInterfaceWrappers.h.
|
inline |
Removes the specified scene graph from the wrapped viewport object.
sceneGraph | [in] Pointer to the root of the scene graph. |
Definition at line 832 of file GsInterfaceWrappers.h.
|
inline |
Removes all scene graphs from the wrapped viewport object.
sceneGraph | [in] Root of scene graph. |
Definition at line 844 of file GsInterfaceWrappers.h.
|
inline |
Checks whether any view parameters have exceeded their boundaries since the last call to this function.
dolly() orbit() pan() roll() setBackClip() setFrontClip() setView() zoom()
Definition at line 1299 of file GsInterfaceWrappers.h.
|
inline |
Checks whether specified WCS box is visible completely or partially inside current view frustum. This method returns false if there is no redirection view.
minPt | [in] minimal WCS box point. |
maxPt | [in] maximal WCS box point. |
Definition at line 1248 of file GsInterfaceWrappers.h.
|
inline |
Returns the WCS projection plane (field) height for the wrapped viewport object. This method returns 1.0 if there is no redirection view.
Definition at line 561 of file GsInterfaceWrappers.h.
|
inline |
Returns the WCS projection plane (field) width for the wrapped viewport object. This method returns 1.0 if there is no redirection view.
Definition at line 550 of file GsInterfaceWrappers.h.
|
inline |
Flushes the graphic pipeline and renders the wrapped viewport object.
Definition at line 987 of file GsInterfaceWrappers.h.
|
inline |
Freezes the specified Layer object in the wrapped viewport object.
layerID | [in] Layer to freeze. |
Definition at line 1032 of file GsInterfaceWrappers.h.
|
inline |
Returns the front clip distance from the target of the wrapped viewport object. This method returns 0.0 if there is no redirection view.
Definition at line 605 of file GsInterfaceWrappers.h.
|
inline |
Returns OdGsModel object associated with specified OdGiDrawable object in the wrapped viewport object. This method returns NULL if there is no redirection view.
pDrawable | [in] Pointer onto OdGiDrawable object. |
Definition at line 856 of file GsInterfaceWrappers.h.
|
inline |
Returns array of OdGsModel objects associated with the wrapped viewport object. This method returns an empty model array if there is no redirection view.
Definition at line 867 of file GsInterfaceWrappers.h.
|
inline |
Returns the display pixel density at the specified point for the wrapped viewport object.
point | [in] WCS center of the unit square. |
pixelDensity | [out] Receives the pixel density. |
bUsePerspective | [in] Enable perspective inclusion into pixel density calculation. |
Definition at line 1480 of file GsInterfaceWrappers.h.
|
inline |
Returns image of current view buffer.
pImage | [out] Pointer for image to return. |
region | [in] Rectangle specifies region to return. |
Definition at line 1592 of file GsInterfaceWrappers.h.
|
inline |
Returns the stereo parameters for the wrapped viewport Object.
magnitude | [out] Receives the view separation [0.0 .. 2.0]. |
parallax | [out] Receives the plane of zero parallax adjustment [0.0 .. 2.0]. |
Definition at line 1366 of file GsInterfaceWrappers.h.
|
inline |
Returns the size and position of the wrapped viewport object.
lowerLeft | [out] Receives the lower-left corner in nomalized device coordinates [0.0 .. 1.0]. |
upperRight | [out] Receives the upper-right corner in nomalized device coordinates [0.0 .. 1.0]. |
screenRect | [out] Receives the screen rectangle in device coordinates (pixels). |
Definition at line 295 of file GsInterfaceWrappers.h.
|
inline |
Returns the size and position of the wrapped viewport object.
screenRect | [out] Receives the screen rectangle in device coordinates (pixels). |
Definition at line 311 of file GsInterfaceWrappers.h.
|
inline |
Returns the size and position of the wrapped viewport object.
screenRect | [out] Receives the screen rectangle in device coordinates (pixels). |
Definition at line 324 of file GsInterfaceWrappers.h.
|
inline |
Returns the color and width of the border for the wrapped viewport object.
color | [out] Receives the border color. |
width | [out] Receives the border width in pixels. |
Definition at line 423 of file GsInterfaceWrappers.h.
|
inline |
Hides the wrapped viewport object.
Definition at line 996 of file GsInterfaceWrappers.h.
|
inline |
Returns an iterator to traverse the lights attached to the wrapped viewport object.
pLightsIterator | [in] Pointer to the lights iterator. |
Definition at line 1376 of file GsInterfaceWrappers.h.
|
inline |
Returns interactivity frame rate. This method returns 0.0 if there is no redirection view.
Definition at line 974 of file GsInterfaceWrappers.h.
|
inline |
Marks the entire area of the wrapped view for refreshing.
Definition at line 877 of file GsInterfaceWrappers.h.
|
inline |
Marks for refresh the specified region of the wrapped viewport object.
screenRect | [in] Screen rectangle in device coordinates (pixels). |
Definition at line 888 of file GsInterfaceWrappers.h.
|
inline |
Marks for regeneration all subViewportDraw() geometry for the wrapped viewport object.
Definition at line 1068 of file GsInterfaceWrappers.h.
|
inline |
Checks whether back clipping is enabled for the wrapped viewport object.
Definition at line 628 of file GsInterfaceWrappers.h.
|
inline |
Checks whether front clipping is enabled for the wrapped viewport object.
Definition at line 584 of file GsInterfaceWrappers.h.
|
inline |
Checks whether the wrapped viewport object is in interactive state.
Definition at line 961 of file GsInterfaceWrappers.h.
|
inline |
Checks whether the projection type for the wrapped viewport object is kPerspective.
Definition at line 539 of file GsInterfaceWrappers.h.
|
inline |
Checks whether stereo viewing is enabled for the wrapped viewport object.
Definition at line 1323 of file GsInterfaceWrappers.h.
|
inline |
Checks whether the wrapped viewport shows the correct image.
Definition at line 906 of file GsInterfaceWrappers.h.
|
inline |
Checks whether viewport border is visibile, false otherwise.
Definition at line 445 of file GsInterfaceWrappers.h.
|
inline |
Checks whether the wrapped viewport object is not hidden. This method returns false if there is no redirection view.
Definition at line 1017 of file GsInterfaceWrappers.h.
|
inline |
Returns the perspective lens length for the wrapped viewport object. This method returns 50.0 if there is no redirection view.
Definition at line 516 of file GsInterfaceWrappers.h.
|
inline |
Returns current alternate linetype scale multiplier value. This method returns 1.0 if there is no redirection view.
Definition at line 1425 of file GsInterfaceWrappers.h.
|
inline |
Returns current linetype scale multiplier value. This method returns 1.0 if there is no redirection view.
Definition at line 1399 of file GsInterfaceWrappers.h.
|
inline |
Returns the scale factor for displaying Lineweights from the wrapped Viewport object. If there is no wrapped view, this method returns 1.0.
Definition at line 207 of file GsInterfaceWrappers.h.
|
inline |
Sets the render mode for the wrapped viewport object.
Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.
This method OdGsView::kNone.
Definition at line 760 of file GsInterfaceWrappers.h.
|
inline |
Retrieves a quantity of root drawables for the wrapped viewport. This method returns 0 if there is no redirection view.
Definition at line 794 of file GsInterfaceWrappers.h.
|
inline |
Returns the matrix that transforms coordinates from model space to screen space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.
Definition at line 708 of file GsInterfaceWrappers.h.
|
inline |
Orbits the camera about the target by the specified amounts.
xOrbit | [in] X-axis Orbit. |
yOrbit | [in] Y-axis Orbit. |
Definition at line 1161 of file GsInterfaceWrappers.h.
|
inline |
Rotates the target about the camera the specified amounts.
xPan | [in] X-axis pan. |
yPan | [in] Y-axis pan. |
Definition at line 1194 of file GsInterfaceWrappers.h.
|
inline |
Checks whether specified point is visible inside current view frustum. This method returns false if there is no redirection view.
pt | [in] WCS point for check. |
Definition at line 1232 of file GsInterfaceWrappers.h.
|
inline |
Checks whether the specified point is inside viewport area. This method returns false if there is no redirection view.
screenPoint | [in] Check point in device coordinate space. |
Definition at line 1462 of file GsInterfaceWrappers.h.
|
inline |
Returns the WCS camera position for the wrapped viewport object. This method returns a 3D point at the origin of world coordinate system if there is no redirection view.
Definition at line 483 of file GsInterfaceWrappers.h.
|
inline |
Returns the matrix that transforms view space to normalized device space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.
Definition at line 671 of file GsInterfaceWrappers.h.
|
inline |
Rotates the camera by the specified amount about the eye vector.
rollAngle | [in] Camera CCW roll angle. |
Definition at line 1139 of file GsInterfaceWrappers.h.
|
inline |
Retrieves a transient object identifier of the root drawable at the specified index. This method returns a not valid smart pointer to a drawable if there is no redirection view.
i | [in] Index of the drawable to return. |
pModelReturn | [in] Index of the drawable to return. |
Definition at line 818 of file GsInterfaceWrappers.h.
|
inline |
Retrieves a persistent object identifier of the root drawable at the specified index. This method returns 0 if there is no redirection view.
i | [in] Index of the drawable to return. |
pModelReturn | [in] Index of the drawable to return. |
Definition at line 806 of file GsInterfaceWrappers.h.
|
inline |
Returns the matrix that transforms normalized device space to screen space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.
Definition at line 682 of file GsInterfaceWrappers.h.
|
inline |
Runs selection procedure inside the wrapped viewport object.
pts | [in] Selection points in device coordinate space. |
nPoints | [in] Count of selection points. |
pReactor | [in] Selection callback pointer. |
mode | [in] Selection mode. |
Definition at line 1084 of file GsInterfaceWrappers.h.
|
inline |
Sets a multiplier that could be used as an alternate scale factor for linetypes in the wrapped viewport object.
linetypeAlternateScaleMultiplier | [in] Alternate linetype scale multiplier. |
Definition at line 1413 of file GsInterfaceWrappers.h.
|
inline |
Sets the back clip distance from the target of the wrapped viewport object.
backClip | [in] Back clip distance. |
Definition at line 639 of file GsInterfaceWrappers.h.
|
inline |
Sets background object for the wrapped view.
backgroundId | [in] New background object ID. |
Definition at line 1494 of file GsInterfaceWrappers.h.
|
inline |
Sets the clear color for the wrapped view.
color | [in] The clear color. |
Definition at line 1448 of file GsInterfaceWrappers.h.
|
inline |
Controls the back clipping of the wrapped viewport object.
enable | [in] Enable back clipping. |
Definition at line 616 of file GsInterfaceWrappers.h.
|
inline |
Controls the front clipping of the wrapped viewport object.
enable | [in] Enable front clipping. |
Definition at line 572 of file GsInterfaceWrappers.h.
|
inline |
Sets the front clip distance from the target of the wrapped viewport object.
frontClip | [in] Front clip distance. |
Definition at line 595 of file GsInterfaceWrappers.h.
|
inline |
Sets the perspective lens length for the wrapped viewport object.
lensLength | [in] Perspective lens length. |
Definition at line 527 of file GsInterfaceWrappers.h.
|
inline |
Sets a multiplier that is used to scale all linetypes in the wrapped viewport object.
linetypeScaleMultiplier | [in] Linetype scale multiplier. |
Definition at line 1387 of file GsInterfaceWrappers.h.
|
inline |
Sets the lineweights for the wrapped Viewport object.
numLineweights | [in] Number of Lineweights. |
lineweights | [in] Array of Lineweights. |
Definition at line 233 of file GsInterfaceWrappers.h.
|
inline |
Sets the scale factor for displaying Lineweights for the wrapped Viewport object.
scale | [in] Scale factor. |
Definition at line 220 of file GsInterfaceWrappers.h.
|
inline |
Sets the render mode for the wrapped viewport object.
mode | [in] Render mode. |
Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.
Definition at line 735 of file GsInterfaceWrappers.h.
|
inline |
Sets the stereo parameters for the wrapped viewport Object.
magnitude | [in] View separation [0.0 .. 2.0]. |
parallax | [in] Adjusts the plane of zero parallax [0.0 .. 2.0]. |
Definition at line 1345 of file GsInterfaceWrappers.h.
|
inline |
Sets current vectorization context.
pUserGiContext | [in] Pointer to vectorization context. |
Definition at line 195 of file GsInterfaceWrappers.h.
|
inline |
Sets the camera parameters for the wrapped viewport object.
position | [in] Camera position. |
target | [in] Camera target. |
upVector | [in] Camera up vector. |
fieldWidth | [in] Projection plane (field) width. |
fieldHeight | [in] Projection plane (field) height. |
projectionType | [in] Projection type. |
Value kParallel 0 kPerspective 1
Definition at line 472 of file GsInterfaceWrappers.h.
|
inline |
Sets the size and position for the wrapped Viewport object.
lowerLeft | [in] Lower-left corner in nomalized device coordinates [0.0 .. 1.0]. |
upperRight | [in] Upper-right corner in nomalized device coordinates [0.0 .. 1.0]. |
Definition at line 248 of file GsInterfaceWrappers.h.
|
inline |
Sets the size and position of the wrapped Viewport object.
screenRect | [in] Screen rectangle in device coordinates (pixels). |
Definition at line 263 of file GsInterfaceWrappers.h.
|
inline |
Sets the size and position of the wrapped viewport object.
screenRect | [in] Screen rectangle in device coordinates (pixels). |
Definition at line 277 of file GsInterfaceWrappers.h.
|
inline |
Defines the 3d clipping for the wrapped viewport object.
pBoundary | [in] 3d clipping boundary. |
pClipInfo | [in] Optional 3d clipping boundary extended data. |
Definition at line 386 of file GsInterfaceWrappers.h.
|
inline |
Sets the color and width of the border for the wrapped viewport object.
color | [in] Border color. |
width | [in] Border width in pixels. |
Definition at line 412 of file GsInterfaceWrappers.h.
|
inline |
Controls the border visibility for the wrapped viewport object.
visible | [in] Controls visibility. |
Definition at line 433 of file GsInterfaceWrappers.h.
|
inline |
Defines a polygonal clip region for the wrapped viewport object.
numCoutours | [in] Number of polygonal contours. |
numVertices | [in] Array of the number of vertices in each polygonal contour. |
vertices | [in] Array of device coordinate (pixel) vertices defining the polygonal contours. |
Definition at line 350 of file GsInterfaceWrappers.h.
|
inline |
Defines a polygonal clip region for the wrapped viewport object.
numCoutours | [in] Number of polygonal contours. |
numVertices | [in] Array of the number of vertices in each polygonal contour. |
vertices | [in] Array of device coordinate (pixel) vertices defining the polygonal contours. |
Definition at line 337 of file GsInterfaceWrappers.h.
|
inline |
Sets visual style for the wrapped view.
visualStyle | [in] New visual style data. |
Definition at line 1546 of file GsInterfaceWrappers.h.
|
inline |
Sets visual style object for the wrapped view.
visualStyleId | [in] New visual style object ID. |
Definition at line 1520 of file GsInterfaceWrappers.h.
|
inline |
Un-hides the wrapped viewport object.
Definition at line 1005 of file GsInterfaceWrappers.h.
|
inline |
Returns ambient occlusion mode for current Viewport object.
Definition at line 1658 of file GsInterfaceWrappers.h.
|
inline |
Returns the WCS camera target for the wrapped viewport object. This method returns (0,0,1) vector if there is no redirection view.
Definition at line 494 of file GsInterfaceWrappers.h.
|
inline |
Thaws the specified Layer object in the wrapped viewport object.
layerID | [in] Layer to thaw. |
Definition at line 1046 of file GsInterfaceWrappers.h.
|
inline |
Flushes any queued graphics to the display device.
Definition at line 919 of file GsInterfaceWrappers.h.
|
inline |
Returns the WCS camera up vector for the wrapped viewport object. This method returns (0,1,0) vector if there is no redirection view.
Definition at line 505 of file GsInterfaceWrappers.h.
|
inline |
Retrieves a pointer to the vectorization context. This method returns NULL if there is no redirection view.
Definition at line 184 of file GsInterfaceWrappers.h.
|
inline |
Returns the matrix that transforms world space to view space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.
Definition at line 660 of file GsInterfaceWrappers.h.
|
inline |
Sets the view parameters of the specified OdGsView object to that of the wrapped viewport object.
pView | [out] Receives the view parameters. |
Definition at line 1275 of file GsInterfaceWrappers.h.
|
inline |
Returns the current 3d clipping for the wrapped viewport object.
ppClipInfo | [out] Optional 3d clipping boundary extended data. |
Definition at line 400 of file GsInterfaceWrappers.h.
|
inline |
Returns a polygonal clip region for the wrapped viewport object.
counts | [out] Array of the number of vertices in each polygonal contour. |
vertices | [out] Array of device coordinate (pixel) vertices defining the polygonal contours. |
Definition at line 374 of file GsInterfaceWrappers.h.
|
inline |
Returns a polygonal clip region for the wrapped viewport object.
counts | [out] Array of the number of vertices in each polygonal contour. |
vertices | [out] Array of device coordinate (pixel) vertices defining the polygonal contours. |
Definition at line 362 of file GsInterfaceWrappers.h.
|
inline |
Returns current visual style object ID for the wrapped view. This method returns NULL if there is no redirection view.
Definition at line 1532 of file GsInterfaceWrappers.h.
|
inline |
Returns current visual style for the wrapped view. This method returns false if there is no redirection view.
visualStyle | [out] OdGiVisualStyle structure to fill by current visual style data. |
Definition at line 1563 of file GsInterfaceWrappers.h.
|
inline |
Returns a matrix that transforms coordinates from world space to screen space for the wrapped viewport object.
Definition at line 697 of file GsInterfaceWrappers.h.
|
inline |
Scales the focal length of the camera by the specified amount.
zoomFactor | [in] Zoom factor. |
Definition at line 1172 of file GsInterfaceWrappers.h.
|
inline |
Scales the camera to completely include specified WCS box inside view frustum.
minPt | [in] minimal WCS box point. |
maxPt | [in] maximal WCS box point. |
Definition at line 1206 of file GsInterfaceWrappers.h.
|
inline |
Scales the camera to completely include specified screen area.
lowerLeft | [in] Lower-left corner in nomalized device coordinates [0.0 .. 1.0]. |
upperRight | [in] Upper-right corner in nomalized device coordinates [0.0 .. 1.0]. |
Definition at line 1218 of file GsInterfaceWrappers.h.