Provides script language access to C++ objects of this type.
Class Hierarchy | No registered superclass. |
Function members are as follows:
Return Type | Function Name | Documentation |
---|---|---|
int32 | AreProgramsEnabled | Test whether <Program> objects are enabled in the rendering device used by the worksheet. |
int32 | ClearRenderVisualizer | Clears the active RenderVisualizer set in the worksheet. |
int32 | GetGridDrawMode | Returns the current grid draw/render mode. |
<Vec> | GetOrientation | Returns a pointer to the <Vec> object that stores the <ModelView> orientation. |
<Vec> | GetPosition | Returns a pointer to the <Vec> object that stores the <ModelView> position. |
int32 | GetProjection | Returns the projection of the active worksheet. |
<RenderVisualizer> | GetRenderVisualizer | Returns a pointer to the RendeVisualizer set in the worksheet. |
int32 | GetViewHeight | Returns the worksheet's height in pixels. |
int32 | GetViewRay | Undocumented |
int32 | GetViewWidth | Returns the worksheet's width in pixels. |
int32 | InverseTransformVec | Transforms a vector using the inverse camera transform of the worksheet. |
int32 | IsFilled | Tests whether or not the worksheet's rendering mode is filled. |
int32 | IsSolid | Tests whether or not the worksheet's rendering mode is solid. |
int32 | IsTextured | Tests whether or not the worksheet's rendering mode is textured. |
int32 | IsWireframe | Tests whether or not the worksheet's rendering mode is wireframe. |
int32 | Lock | Lock the worksheet from being updated. Use this function if you want to perform a series of operations on the worksheet without the chance that it will be updated while the operations are in progress. |
<Model3D> | Model | Returns a pointer to the Model to which the worksheet is attached. |
int32 | Release | Unlocks the worksheet and allow updates. Use this function in conjunction with Lock to perform a series of operations on the worksheet without the chance that the worksheet may be updated while the operations are in progress. |
int32 | RenderFilled | Sets the rendering mode to filled. |
int32 | RenderProgramsEnabled | Enables or disables <Program> objects in the rendering device used by the worksheet. |
int32 | RenderSolid | Sets the rendering mode to solid. |
int32 | RenderTextured | Sets the rendering mode to texture-mapped. |
int32 | RenderWireframe | Sets the rendering mode to wireframe. |
int32 | SetFront | Sets the worksheet projection to Front. |
int32 | SetGridOverlay | Sets the grid draw mode to Overlay. |
int32 | SetGridUnderlay | Sets the grid draw mode to Underlay. |
int32 | SetGridZBuffer | Sets the grid draw mode to ZBuffer. |
int32 | SetPerspective | Sets the worksheet projection to Perspective. |
int32 | SetRenderVisualizer | Sets a new render visualizer in the worksheet. |
int32 | SetSide | Sets the worksheet projection to Side. |
int32 | SetTop | Sets the worksheet projection to Top. |
int32 | Update | Updates the worksheet. |
Object members are as follows:
Type Name | Accessor Name | Documentation |
---|---|---|
<Color> | ActiveViewColor | Gets or sets the color used to indicate the active model view. This color is drawn as a line surrounding the worksheet. |
<Color> | BottomColor | Gets or sets the bottom background color used by the worksheet. The worksheet supports a 3 color gradient background color: top, middle and bottom. |
<Color> | BoundingBoxColor | Gets or sets the rendered bounding box color used by the worksheet. |
<Color> | DrawingColor | Gets or sets the rendered line color used when a line drawing tool is active in the worksheet. |
<Color> | FogColor | Gets or sets the fog color used by the worksheet. |
<Color> | GridColor | Gets or sets the rendered minor grid line color used by the worksheet. |
<Color> | GridQuadrantColor | Gets or sets the rendered major grid line color used by the worksheet. |
<Color> | MiddleColor | Gets or sets the middle background color used by the worksheet. The worksheet supports a 3 color gradient background color: top, middle and bottom. |
<Vec> | Orientation | Returns a pointer to a <Vec> object that contains the current view orientation. |
<Vec> | Position | Returns a pointer to a <Vec> object that contains the current view position. |
<Render3D> | Render | Returns a pointer to the rendering device used to render content for a particular <ModelView>. |
<Color> | SelectionRectangleColor | Gets or sets the rendered selection rectangle color used by the worksheet. |
<Color> | TopColor | Gets or sets the top background color used by the worksheet. The worksheet supports a 3 color gradient background color: top, middle and bottom. |
<Color> | XAxisColor | Gets or sets the rendered x-axis color used by the worksheet. |
<Color> | YAxisColor | Gets or sets the rendered y-axis color used by the worksheet. |
<Color> | ZAxisColor | Gets or sets the rendered z-axis color used by the worksheet. |
int32 | Axes | Toggles world origin display. |
int32 | Backfacing | Gets or sets whether or not the worksheet renders backfacing faces. |
int32 | DoubleClickToSetFocus | Controls whether a worksheet view is activated by single-clicking or double-clicking on it. |
int32 | Edges | Toggles <Mesh> edge display. |
int32 | FaceNormals | Toggles face normal display. |
float64 | FarClip | Gets or sets the worksheet's far clipping value. |
int32 | Fog | Gets or sets whether or not the worksheet is rendering fog. |
float64 | FogEnd | Gets or sets the worksheet's FogEnd parameter. |
float64 | FogStart | Gets or sets the worksheet's FogStart parameter. |
int32 | FullBoundingBox | Toggles global full/partial bounding box display. |
int32 | GlobalEdges | Toggles global <Mesh> edge display. |
int32 | GlobalFaceNormals | Toggles global face normal display. |
int32 | GlobalHiddenEdges | Toggles global hidden edge display. |
int32 | GlobalTangents | Toggles global tangent display. |
int32 | GlobalVertexNormals | Toggles global vertex normal display. |
int32 | GlobalVertices | Toggles global vertex display. |
int32 | Grid | Toggles global grid display. |
int32 | Handles | Toggles global handle display. |
int32 | HiddenEdges | Toggles <Mesh> hidden edge display. |
int32 | LocalAxes | Toggles local axis display. |
float64 | NearClip | Gets or sets the worksheet's near clipping value. |
int32 | QuadrantSpacing | Gets or sets the grid quadrant spacing. Valid values are between 1 and 256, inclusive. |
float64 | SelectionRectangleOpacity | Gets or sets the worksheet's selection rectangle opacity. |
int32 | SnapToEdges | Toggles snap-to-edges. |
int32 | SnapToFaces | Toggles snap-to-polygons. |
int32 | SnapToGrid | Toggles snap-to-grid. |
int32 | SnapToPoints | Toggles snap-to-points. |
int32 | TimeChanged | Gets or sets a value specifying how often the worksheet should be updated, for example to perform animations. The value is in milliseconds, and can be set to 0 to stop automatic view updates. |
int32 | VertexNormals | Toggles vertex normal display. |
int32 | Vertices | Toggles <Mesh> vertex display. |
float64 | Zoom | Gets or sets the worksheet's zoom value. |