Jump to content

SceneWindow class

From LabVIEW Wiki
Revision as of 23:26, 1 September 2019 by Q (talk | contribs)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name SceneWindow class
Class ID 84
Scope Basic Development Environment
Class Inheritance
Class Children

This class has no children.


    The SceneWindow class is a class in the VI Server Class Hierarchy, (see also VI Server).

    Properties

    Show/Hide SceneWindow Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    SceneWindow Properties Table
    Property ID Short Name (English) Description R/W RTE
    C55E80D AutoProjection Reads or writes whether LabVIEW automatically updates the projection mode when you resize the scene window. R/W X
    C55E802 BackgroundColor Reads or writes the RGBA color value for the background of the 3D scene.

    Elements:

    • Name
    • Description
    • Red - Indicates the red value. Valid values include 0 through 1.
    • Green - Indicates the green value. Valid values include 0 through 1.
    • Blue - Indicates the blue value. Valid values include 0 through 1.
    • Alpha - Indicates the Alpha value. Set the Alpha value on the background of a 3D scene only for blending. Setting this value does not make the background of the 3D scene transparent. Valid values include 0 through 1.
    R/W X
    C55E80E CameraController.AutoRedraw Reads or writes if the scene window becomes invalid when you use the camera controller. R/W X
    C55E807 CameraController.Type Reads or writes the configuration of the scene camera. Click and hold the left mouse button and drag the cursor to operate the camera. R/W X
    C55E801 ModelViewMatrix Reads or writes a matrix that contains the translation, rotation, and scale values for the 3D scene that appears in the scene window. R/W X
    C55E809 ProjectionMatrix Read or writes the matrix that represents the transformations LabVIEW uses to project the 3D scene in the scene window. R/W X
    C55E800 Scene Reads or writes the reference number for the scene. R/W X
    C55E80A WinBounds Reads or writes the left, right, top, and bottom bounds of the scene window.

    Elements:

    • Name
    • Description
    • Left - The horizontal coordinate of the left edge of the scene window.
    • Top - The vertical coordinate of the top edge of the scene window.
    • Right - The horizontal coordinate of the right edge of the scene window.
    • Bottom - The vertical coordinate of the bottom edge of the scene window.
    R/W X
    C55E80C State Reads or writes the state of the scene window. R/W X
    C55E80B WinTitle Reads or writes the title of the scene window. R/W X

    Methods

    Show/Hide SceneWindow Methods Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    SceneWindow Methods Table
    Method ID Short Name (English) Description RTE
    C55E407 AutoFocus Positions the camera to view all 3D scene objects. Use this method to automatically focus and render the scene in an exterior window. X
    C55E405 Pick Creates a ray that originates at the specified point and returns an array of node paths for objects that intersect that ray. X
    C55E401 Projection.Frustum Sets coordinates to render the scene in a frustum-shaped view. This projection causes objects farther from the camera to appear smaller. X
    C55E402 Projection.Orthographic Sets coordinates to render the scene in a box-shaped view. The distance of the camera from the objects does not affect the size of the objects in this view. X
    C55E403 Projection.Perspective Sets coordinates to render the scene in a frustum-shaped view, where you specify an angle for the horizontal and vertical viewing fields. This projection causes objects closer to the camera to appear larger in size. This method is similar to the Projection:Frustum method. X
    C55E406 Redraw Redraws the 3D scene in the scene window. X
    C55E404 Render to Image Returns an image of the scene. X
    C55E400 Setup Camera Specifies the position of the camera relative to the scene. X
    C55E408 WindowToObjectCoords Converts a point in window coordinates to points in object coordinates on the near and far clip planes. X

    Events

    No Events for this class.

    History

    Version Change(s)
    LabVIEW 2018 More info to come.

    See Also