SceneObject class
| VI Server Class Information | |
|---|---|
| Return to VI Server Class Hierarchy | |
| Class Name | SceneObject class |
| Class ID | 105 |
| Scope | Basic Development Environment |
| Class Inheritance |
|
| Class Children | This class has no children.
|
 |
This article is a stub. You can help LabVIEW Wiki by expanding it. Please improve this article if you can. |
The SceneObject class is a class in the VI Server Class Hierarchy, (see also VI Server).
Contents |
Properties
Show/Hide SceneObject Properties Table
| Legend | |
|---|---|
| R/W | Readable/Writable Permissions |
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Property ID | Long Name (English) | Description | R/W | RTE |
|---|---|---|---|---|
| 2D877800 | Geometry | Read Only | Yes | |
| 2D877801 | Texture | Reads the texture that you apply to the 3D object. | Read Only | Yes |
| 2D877803 | Blending:Mode | Reads or writes if the color values you apply to a 3D object blend. | Read/Write | Yes |
| 2D877804 | Blending:Bin | Reads or writes the draw bin in which you drop and store objects. The bin of an object affects the order in which the object appears when you render the scene. | Read/Write | Yes |
| 2D877806 | Blending:Function:Destination | Reads or writes the blend factor you apply to the color values of the currently stored pixels. | Read/Write | Yes |
| 2D87780A | Draw Style:Mode | Reads or writes the method you use to draw the 3D object. You can choose from the following options: | Read/Write | Yes |
| 2D87780B | Draw Style:Frontface Mode | Reads or writes how you determine the front-facing polygons of the 3D object. | Read/Write | Yes |
| 2D87780C | Draw Style:Face Culling Mode | Reads or writes the culling method you apply to the object. | Read/Write | Yes |
| 2D87780E | Draw Style:Line Width | Reads or writes the width of lines drawn for the 3D object. Set the value to -1 to inherit the line width of a parent object. | Read/Write | Yes |
| 2D87780F | Draw Style:Point Size | Reads or writes the size of the points you use to draw the geometry. Set the value to -1 to inherit the point size of a parent object. | Read/Write | Yes |
| 2D877810 | Fog:Function | Reads or writes the blending factor you use to apply fog to an object. | Read/Write | Yes |
| 2D877811 | Fog:Start | Reads or writes the point at which the fog effects you apply to the object begin. | Read/Write | Yes |
| 2D877812 | Fog:End | Reads or writes the point at which fog effects end. Fog grows denser as you move away from the camera but cuts off completely at the specified fog end point. | Read/Write | Yes |
| 2D877813 | Fog:Density | Reads or writes the density of the fog you apply to the object. Valid values include any non-negative, floating-point number between 0 and 1. | Read/Write | Yes |
| 2D877814 | Fog:Color | Reads or writes the RGBA color value of the fog. The elements of this property accept values 0 to 1, where 0 represents the absence of the red, green, or blue color and 1 represents a full saturation of the current color. | Read/Write | Yes |
| 2D877815 | Material:Color Mode | Reads or writes how the 3D object reacts to light. Materials only appear in lighted scenes. | Read/Write | Yes |
| 2D877816 | Material:Ambient | Reads or writes the RGBA color value of the object that the ambient light affects. Materials only appear in lighted scenes. | Read/Write | Yes |
| 2D877817 | Material:Diffuse | Reads or writes the RGBA color value of the lit object based on the angle between the orientation of the object and the direction of the light source. Materials only appear in lighted scenes. | Read/Write | Yes |
| 2D877818 | Material:Specular | Reads or writes the RGBA color value of the object that represents the reflection of specular light off of the object. Materials only appear in lighted scenes. | Read/Write | Yes |
| 2D87781A | Material:Shininess | Reads or writes the size of the highlight that appears on the object when light reflects specularly off the object. Shine can be a value from 0−128. Materials only appear in lighted scenes. | Read/Write | Yes |
| 2D87781B | Specials:Anti-aliasing | Read or writes whether the object is anti-aliased to smooth lines and edges that appear jagged. | Read/Write | Yes |
| 2D87781C | Specials:Autonormalizing | Read or writes whether the vertex normals of the object automatically normalize to enhance rendering speed. | Read/Write | Yes |
| 2D87781D | Specials:Shade Model | Reads or writes whether a color-filled object appears shaded with one color or multiple colors. | Read/Write | Yes |
| 2D877822 | Specials:Depth Test | Reads or writes whether the pixels of the 3D object pass the depth test. If the object passes the depth test, the incoming depth value replaces the value in the depth buffer when you render the scene. | Read/Write | Yes |
| 2D877823 | Specials:Lighting | Reads or writes whether a 3D object appears lit. | Read/Write | Yes |
| 2D877824 | Specials:Texturing | Reads or writes whether a 3D object appears with a texture. This property must be set to On to apply textures to an object. | Read/Write | Yes |
| 2D877825 | Blending:Function:Source | Reads or writes the blend factor you apply to the color values of the incoming fragment. | Read/Write | Yes |
| 2D877827 | Material:Emission | Reads or writes the RGBA color value of the emissive light of the object. Emissive light emanates from the object itself instead of an external light source. Materials only appear in lighted scenes. | Read/Write | Yes |
| 2D877828 | Transformation | Reads or writes the transformation you apply to the object. | Read/Write | Yes |
| 2D877829 | View Port:Mode | Reads or writes how to specify the size of the view port you use to view the scene. | Read/Write | Yes |
| 2D87782A | View Port:View Port | Reads or writes the position and size of a viewing port through which you can view a 3D object in the 3D picture control. The x and y values specify the coordinates within the view port at which LabVIEW renders the object. The width and height specify the width and height of the view port. If you define a view port, objects do not appear beyond the specified bounds of the view port. | Read/Write | Yes |
| 2D87782B | Drawable | Returns the drawable attribute applied to a 3D object. Drawable attributes include geometries and text. You must close this reference. | Read Only | Yes |
| 2D87782C | Line Stipple:Mode | Sets the mode for line stipple. | Read/Write | Yes |
| 2D87782D | Line Stipple:Factor | The multiplier on the line stipple pattern. LabVIEW uses each bit factor number of times. Valid values range from 1 to 256, inclusive. | Read/Write | Yes |
| 2D87782E | Line Stipple:Pattern | Bit pattern for line stippling. This property converts a 16-bit unsigned integer into binary. For example, if you input the number 5, the bit pattern is 101. The bit pattern determines if the fragment is drawn on the graph. The Line Stipple:Factor property determines the size of the fragment. | Read/Write | Yes |
| 2D87782F | Billboard:Mode | Sets the billboard mode for the 3D graph object. If the mode is No Billboarding, the object normal is set to default. | Read Only | Yes |
| 2D877830 | Billboard:Normal | The vector that describes the direction the object is facing before the object rotates. LabVIEW ignores this property if the value of Billboard:Mode is No Billboarding. | Read Only | Yes |
| 2D877831 | Billboard:Axis | Returns the axis that rotates if Billboard:Mode is axial. | Read Only | Yes |
| 2D877832 | Billboard:Positions | Returns the positions of the objects to be billboarded. | Read Only | Yes |
| 2D877833 | PolygonOffset:Mode | Gets/sets the mode for polygon offset. | Read/Write | Yes |
| 2D877834 | PolygonOffset:Factor | Gets or sets the polygon offset factor. Changes to this property cause the polygon mode to change to off if it was inherited previously. | Read/Write | Yes |
| 2D877835 | PolygonOffset:Units | Gets or sets the polygon offset units. Changes to this property cause the polygon mode to change to off if it was inherited previously. | Read/Write | Yes |
| 2D877836 | Visible | Read/Write | Yes |
Methods
Show/Hide SceneObject Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 2D877400 | Object:Add Object | Reads or writes a 3D object you add to a 3D scene. If you wire the Object output, you must close the reference when you no longer need it. | Yes (Read/Write) |
| 2D877409 | Object:Object Count | Returns the number of children directly under the scene object. | Yes (Read/Write) |
| 2D877415 | Object:Remove Object | Removes a child object from the 3D object. | Yes (Read/Write) |
| 2D877416 | Transformation:Rotate | Rotates the object around the given Axis by the Angle. This method performs a relative rotation from the current position of the object. | Yes (Read/Write) |
| 2D877417 | Transformation:Translate | Translates the object by the specified vector. This method performs a relative translation from the initial position of the object. | Yes (Read/Write) |
| 2D877418 | Transformation:Scale | Scales the object by the specified scaling factor. This method performs a relative scale from the current position of the object. | Yes (Read/Write) |
| 2D877419 | Transformation:Set Rotation | Rotates the object around the given Axis by the Angle. This method performs an absolute rotation from the current position of the object. | Yes (Read/Write) |
| 2D87741A | Transformation:Set Translation | Translates the object by the specified vector. This method performs an absolute translation from the initial position of the object. | Yes (Read/Write) |
| 2D87741B | Transformation:Set Scale | Scales the object by the specified scaling factor. This method performs an absolute scale from the current position of the object. | Yes (Read/Write) |
| 2D87741C | Transformation:Clear | Clears any transformations applied to the object and sets the transformation property to the identity matrix. | Yes (Read/Write) |
| 2D87741D | Light:Get State | Returns the state of the light. | Yes (Read/Write) |
| 2D87741E | Light:Set State | Sets a state for the light. | Yes (Read/Write) |
| 2D87741F | Clip Plane:Get State | Returns the state of the clip plane applied to an object in a 3D scene. | Yes (Read/Write) |
| 2D877420 | Clip Plane:Set State | Sets a state for the clip plane. | Yes (Read/Write) |
| 2D877421 | Object:Get Object | Returns a reference to a child object identified by the index you specify. | Yes (Read/Write) |
| 2D877422 | Set Geometry | Yes | |
| 2D877423 | Texture:Set Texture | Reads or writes the texture you apply to an object in a 3D scene. | Yes (Read/Write) |
| 2D877424 | Texture:Remove Texture | Removes the texture image associated with the object. If texturing is enabled, the object inherits the texture of its parent after this method executes. | Yes (Read/Write) |
| 2D877425 | Light:Add Light | Reads or writes the light you add to a 3D scene. If you wire the Light output, you must close the reference when you no longer need it. | Yes (Read/Write) |
| 2D877426 | Clip Plane:Add Clip Plane | Adds a clip plane to the 3D scene. If you wire the Clip Plane output, you must close the reference when you no longer need it. | Yes (Read/Write) |
| 2D877427 | Transformation:Get Rotation | Returns the Axis and Angle that define the rotation of the object. | Yes (Read/Write) |
| 2D877428 | Transformation:Get Translation | Returns the translation of the object. | Yes (Read/Write) |
| 2D877429 | Transformation:Get Scale | Returns the scale factors of the object. | Yes (Read/Write) |
| 2D87742A | Light:Get Light | Gets the child light owned by this object at the given index. | Yes (Read/Write) |
| 2D87742B | Clip Plane:Get Clip Plane | Gets the child clip plane owned by this object at the given index. | Yes (Read/Write) |
| 2D87742C | Light:Remove Light | Removes the given light owned by this object. | Yes (Read/Write) |
| 2D87742D | Clip Plane:Remove Clip Plane | Removes the given clip plane if it is owned by this object. | Yes (Read/Write) |
| 2D87742E | Light:Light Count | Returns the number of lights directly owned by this object. | Yes (Read/Write) |
| 2D87742F | Clip Plane:Clip Plane Count | Returns the number of clip planes directly owned by this object. | Yes (Read/Write) |
| 2D877430 | Object:Find Object | Takes a 3D scene reference and an object name and returns the first object in the scene with a matching name. | Yes (Read/Write) |
| 2D877431 | Set Drawable | Specifies the drawable attribute to apply to a 3D object. Drawable attributes include geometries and text. You must specify a drawable attribute for the object to appear in the 3D scene. | Yes (Read/Write) |
| 2D877432 | Set Billboard Params | Sets or updates parameters for billboarding. | Yes (Read/Write) |
| 2D877433 | Meshify | Yes | |
| 2D877434 | Bounding:Get Box | Yes | |
| 2D877435 | Bounding:Get Sphere | Yes |
Events
This class has no events or it inherits events from its parent: SceneNode Class.
History
 |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |