Jump to content

SceneObject class: Difference between revisions

From LabVIEW Wiki
← Older edit
Visual
mNo edit summary
m Removed VI Server Category from page
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide SceneObject Properties Table</span>
{{VIServerClassTables|105}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ SceneObject Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|2D877831
| [[SceneObject class/Billboard.Axis property|Billboard.Axis]]
|Returns the axis that rotates if Billboard:Mode is axial.
|R
|X
|- style="background-color:#FFFFCC;"
|2D87782F
| [[SceneObject class/Billboard.Mode property|Billboard.Mode]]
|Sets the billboard mode for the 3D graph object. If the mode is No Billboarding, the object normal is set to default.
|R
|X
|- style="background-color:#FFFFCC;"
|2D877830
| [[SceneObject class/Billboard.Normal property|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.
|R
|X
|- style="background-color:#FFFFCC;"
|2D877832
| [[SceneObject class/Billboard.Positions property|Billboard.Positions]]
|Returns the positions of the objects to be billboarded.
|R
|X
|- style="background-color:#FFFFCC;"
|2D877804
| [[SceneObject class/Blending.Bin property|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877806
| [[SceneObject class/Blending.Function.Destination property|Blending.Function.Destination]]
|Reads or writes the blend factor you apply to the color values of the currently stored pixels.
 
The following source and destination color components are described as (Rs, Gs, Bs, As) for source components and (Rd, Gd, Bd, Ad) for destination components.
 
The components have integer values between 0 and (kR, kG, kB, kA), where kR&#61;2mR 1, kG&#61;2mG 1, kB&#61;2mB 1, and kA&#61;2mA 1.
 
(mR, mG, mB, mA) is the number of bitplanes for each red, green, blue, and alpha value.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877825
| [[SceneObject class/Blending.Function.Source property|Blending.Function.Source]]
|Reads or writes the blend factor you apply to the color values of the incoming fragment.
 
The following source and destination color components are described as (Rs, Gs, Bs, As) for source components and (Rd, Gd, Bd, Ad) for destination components.
 
The components have integer values between 0 and (kR, kG, kB, kA), where kR&#61;2mR 1, kG&#61;2mG 1, kB&#61;2mB 1, and kA&#61;2mA 1.
 
(mR, mG, mB, mA) is the number of bitplanes for each red, green, blue, and alpha value.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877803
| [[SceneObject class/Blending.Mode property|Blending.Mode]]
|Reads or writes if the color values you apply to a 3D object blend.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87780C
| [[SceneObject class/DrawStyle.FaceCullingMode property|DrawStyle.FaceCullingMode]]
|Reads or writes the culling method you apply to the object.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87780B
| [[SceneObject class/DrawStyle.FrontfaceMode property|DrawStyle.FrontfaceMode]]
|Reads or writes how you determine the front-facing polygons of the 3D object.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87780E
| [[SceneObject class/DrawStyle.LineWidth property|DrawStyle.LineWidth]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87780A
| [[SceneObject class/DrawStyle.Mode property|DrawStyle.Mode]]
|Reads or writes the method you use to draw the 3D object. You can choose from the following options:
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87780F
| [[SceneObject class/DrawStyle.PointSize property|DrawStyle.PointSize]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87782B
| [[SceneObject class/Drawable property|Drawable]]
|Returns the drawable attribute applied to a 3D object. Drawable attributes include geometries and text. You must close this reference.
|R
|X
|- style="background-color:#FFFFCC;"
|2D877814
| [[SceneObject class/Fog.Color property|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.
 
Elements:
*Name
*Description
*Red - Indicates the saturation of the red color. Valid values include 0 through 1.
*Green - Indicates the saturation of the green color. Valid values include 0 through 1.
*Blue - Indicates the saturation of the blue color. Valid values include 0 through 1.
*Alpha - Indicates the level of transparency of the red, green, and blue colors. Valid values include 0 through 1.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877813
| [[SceneObject class/Fog.Density property|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877812
| [[SceneObject class/Fog.End property|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877810
| [[SceneObject class/Fog.Function property|Fog.Function]]
|Reads or writes the blending factor you use to apply fog to an object.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877811
| [[SceneObject class/Fog.Start property|Fog.Start]]
|Reads or writes the point at which the fog effects you apply to the object begin.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87782D
| [[SceneObject class/Line Stipple.Factor property|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87782C
| [[SceneObject class/Line Stipple.Mode property|Line Stipple.Mode]]
|Sets the mode for line stipple.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87782E
| [[SceneObject class/Line Stipple.Pattern property|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877816
| [[SceneObject class/Material.Ambient property|Material.Ambient]]
|Reads or writes the RGBA color value of the object that the ambient light affects. Materials only appear in lighted scenes.
 
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. Valid values include 0 through 1.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877815
| [[SceneObject class/Material.ColorMode property|Material.ColorMode]]
|Reads or writes how the 3D object reacts to light. Materials only appear in lighted scenes.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877817
| [[SceneObject class/Material.Diffuse property|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.
 
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. Valid values include 0 through 1.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877827
| [[SceneObject class/Material.Emission property|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.
 
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. Valid values include 0 through 1.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87781A
| [[SceneObject class/Material.Shininess property|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&#8722;128. Materials only appear in lighted scenes.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877818
| [[SceneObject class/Material.Specular property|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.
 
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. Valid values include 0 through 1.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877834
| [[SceneObject class/PolygonOffset.Factor property|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877833
| [[SceneObject class/PolygonOffset.Mode property|PolygonOffset.Mode]]
|Gets/sets the mode for polygon offset.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877835
| [[SceneObject class/PolygonOffset.Units property|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87781B
| [[SceneObject class/Specials.Anti-aliasing property|Specials.Anti-aliasing]]
|Read or writes whether the object is anti-aliased to smooth lines and edges that appear jagged.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87781C
| [[SceneObject class/Specials.Autonormalizing property|Specials.Autonormalizing]]
|Read or writes whether the vertex normals of the object automatically normalize to enhance rendering speed.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877822
| [[SceneObject class/Specials.DepthTest property|Specials.DepthTest]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877823
| [[SceneObject class/Specials.Lighting property|Specials.Lighting]]
|Reads or writes whether a 3D object appears lit.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87781D
| [[SceneObject class/Specials.ShadeModel property|Specials.ShadeModel]]
|Reads or writes whether a color-filled object appears shaded with one color or multiple colors.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877824
| [[SceneObject class/Specials.Texturing property|Specials.Texturing]]
|Reads or writes whether a 3D object appears with a texture. This property must be set to <b>On</b> to apply textures to an object.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877801
| [[SceneObject class/Texture property|Texture]]
|Reads the texture that you apply to the 3D object.
 
You must close this reference.
|R
|X
|- style="background-color:#FFFFCC;"
|2D877828
| [[SceneObject class/Transformation property|Transformation]]
|Reads or writes the transformation you apply to the object.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D877829
| [[SceneObject class/ViewPort.Mode property|ViewPort.Mode]]
|Reads or writes how to specify the size of the view port you use to view the scene.
|R/W
|X
|- style="background-color:#FFFFCC;"
|2D87782A
| [[SceneObject class/ViewPort.ViewPort property|ViewPort.ViewPort]]
|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.
 
Elements:
*Name
*Description
*X - The x coordinate at which LabVIEW renders the object in the view port.
*Y - The y coordinate at which LabVIEW renders the object in the view port.
*Width - The width of the view port in pixels.
*Height - The height of the view port in pixels.
|R/W
|X
|- style="background-color:#D1BB80;"
|2D877836
| [[SceneObject class/Visible property|Visible]]
|
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide SceneObject Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ SceneObject Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#D1BB80;"
|2D877434
| [[SceneObject class/Bounding.Get Box method|Bounding.Get Box]]
|
|X
|- style="background-color:#D1BB80;"
|2D877435
| [[SceneObject class/Bounding.Get Sphere method|Bounding.Get Sphere]]
|
|X
|- style="background-color:#FFFFCC;"
|2D877426
| [[SceneObject class/Clip Plane.Add Clip Plane method|Clip Plane.Add Clip Plane]]
|Adds a clip plane to the 3D scene. If you wire the <b>Clip Plane</b> output, you must close the reference when you no longer need it.
|X
|- style="background-color:#FFFFCC;"
|2D87742F
| [[SceneObject class/Clip Plane.Clip Count method|Clip Plane.Clip Count]]
|Returns the number of clip planes directly owned by this object.
|X
|- style="background-color:#FFFFCC;"
|2D87742B
| [[SceneObject class/Clip Plane.Get Clip method|Clip Plane.Get Clip]]
|Gets the child clip plane owned by this object at the given index.
|X
|- style="background-color:#FFFFCC;"
|2D87741F
| [[SceneObject class/Clip Plane.Get State method|Clip Plane.Get State]]
|Returns the state of the clip plane applied to an object in a 3D scene.
|X
|- style="background-color:#FFFFCC;"
|2D87742D
| [[SceneObject class/Clip Plane.Remove Clip method|Clip Plane.Remove Clip]]
|Removes the given clip plane if it is owned by this object.
|X
|- style="background-color:#FFFFCC;"
|2D877420
| [[SceneObject class/Clip Plane.Set State method|Clip Plane.Set State]]
|Sets a state for the clip plane.
|X
|- style="background-color:#FFFFCC;"
|2D877425
| [[SceneObject class/Light.Add Light method|Light.Add Light]]
|Reads or writes the light you add to a 3D scene.  If you wire the <b>Light</b> output, you must close the reference when you no longer need it.
|X
|- style="background-color:#FFFFCC;"
|2D87742A
| [[SceneObject class/Light.Get Light method|Light.Get Light]]
|Gets the child light owned by this object at the given index.
|X
|- style="background-color:#FFFFCC;"
|2D87741D
| [[SceneObject class/Light.Get State method|Light.Get State]]
|Returns the state of the light.
|X
|- style="background-color:#FFFFCC;"
|2D87742E
| [[SceneObject class/Light.Light Count method|Light.Light Count]]
|Returns the number of lights directly owned by this object.
|X
|- style="background-color:#FFFFCC;"
|2D87742C
| [[SceneObject class/Light.Remove Light method|Light.Remove Light]]
|Removes the given light owned by this object.
|X
|- style="background-color:#FFFFCC;"
|2D87741E
| [[SceneObject class/Light.Set State method|Light.Set State]]
|Sets a state for the light.
|X
|- style="background-color:#D1BB80;"
|2D877433
| [[SceneObject class/Meshify method|Meshify]]
|
|X
|- style="background-color:#FFFFCC;"
|2D877400
| [[SceneObject class/Object.Add Object method|Object.Add Object]]
|Reads or writes a 3D object you add to a 3D scene.  If you wire the <b>Object</b> output, you must close the reference when you no longer need it.
|X
|- style="background-color:#FFFFCC;"
|2D877430
| [[SceneObject class/Object.FindObject method|Object.FindObject]]
|Takes a 3D scene reference and an object name and returns the first object in the scene with a matching name.
|X
|- style="background-color:#FFFFCC;"
|2D877421
| [[SceneObject class/Object.Get Object method|Object.Get Object]]
|Returns a reference to a child object identified by the <b>index</b> you specify.
|X
|- style="background-color:#FFFFCC;"
|2D877409
| [[SceneObject class/Object.Object Count method|Object.Object Count]]
|Returns the number of children directly under the scene object.
|X
|- style="background-color:#FFFFCC;"
|2D877415
| [[SceneObject class/Object.Remove Object method|Object.Remove Object]]
|Removes a child object from the 3D object.
|X
|- style="background-color:#FFFFCC;"
|2D877432
| [[SceneObject class/SetBillboardParams method|SetBillboardParams]]
|Sets or updates parameters for billboarding.
|X
|- style="background-color:#FFFFCC;"
|2D877431
| [[SceneObject class/Set Drawable method|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.
|X
|- style="background-color:#FFFFCC;"
|2D877424
| [[SceneObject class/Texture.RemoveTexture method|Texture.RemoveTexture]]
|Removes the texture image associated with the object. If texturing is enabled, the object inherits the texture of its parent after this method executes.
|X
|- style="background-color:#FFFFCC;"
|2D877423
| [[SceneObject class/Texture.Set Texture method|Texture.Set Texture]]
|Reads or writes the texture you apply to an object in a 3D scene.
|X
|- style="background-color:#FFFFCC;"
|2D87741C
| [[SceneObject class/Transformation.Clear method|Transformation.Clear]]
|Clears any transformations applied to the object and sets the transformation property to the identity matrix.
|X
|- style="background-color:#FFFFCC;"
|2D877427
| [[SceneObject class/Transformation.Get Rotation method|Transformation.Get Rotation]]
|Returns the <b>Axis</b> and <b>Angle</b> that define the rotation of the object.
|X
|- style="background-color:#FFFFCC;"
|2D877429
| [[SceneObject class/Transformation.Get Scale method|Transformation.Get Scale]]
|Returns the scale factors of the object.
|X
|- style="background-color:#FFFFCC;"
|2D877428
| [[SceneObject class/Transformation.Get Translation method|Transformation.Get Translation]]
|Returns the  translation of the object.
|X
|- style="background-color:#FFFFCC;"
|2D877416
| [[SceneObject class/Transformation.Rotate method|Transformation.Rotate]]
|Rotates the object around the given <b>Axis</b> by the <b>Angle</b>. This method performs a relative rotation from the current position of the object.
|X
|- style="background-color:#FFFFCC;"
|2D877418
| [[SceneObject class/Transformation.Scale method|Transformation.Scale]]
|Scales the object by the specified scaling factor. This method performs a relative scale from the current position of the object.
|X
|- style="background-color:#FFFFCC;"
|2D877419
| [[SceneObject class/Transformation.Set Rotation method|Transformation.Set Rotation]]
|Rotates the object around the given <b>Axis</b> by the <b>Angle</b>. This method performs an absolute rotation from the current position of the object.
|X
|- style="background-color:#FFFFCC;"
|2D87741B
| [[SceneObject class/Transformation.Set Scale method|Transformation.Set Scale]]
|Scales the object by the specified scaling factor. This method performs an absolute scale from the current position of the object.
|X
|- style="background-color:#FFFFCC;"
|2D87741A
| [[SceneObject class/Transformation.SetTranslation method|Transformation.SetTranslation]]
|Translates the object by the specified vector. This method performs an absolute translation from the initial position of the object.
|X
|- style="background-color:#FFFFCC;"
|2D877417
| [[SceneObject class/Transformation.Translate method|Transformation.Translate]]
|Translates the object by the specified vector. This method performs a relative translation from the initial position of the object.
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 535: Line 24:
*[[VI Server]]
*[[VI Server]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]

Latest revision as of 01:59, 8 May 2020

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).

    Properties

    Show/Hide SceneObject Properties Table

    Legend
    R/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    SceneObject Properties Table
    Property ID Long Name (English) Description R/W RTE
    2D877800GeometryRead OnlyYes
    2D877801TextureReads the texture that you apply to the 3D object.Read OnlyYes
    2D877803Blending:ModeReads or writes if the color values you apply to a 3D object blend.Read/WriteYes
    2D877804Blending:BinReads 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/WriteYes
    2D877806Blending:Function:DestinationReads or writes the blend factor you apply to the color values of the currently stored pixels.Read/WriteYes
    2D87780ADraw Style:ModeReads or writes the method you use to draw the 3D object. You can choose from the following options:Read/WriteYes
    2D87780BDraw Style:Frontface ModeReads or writes how you determine the front-facing polygons of the 3D object.Read/WriteYes
    2D87780CDraw Style:Face Culling ModeReads or writes the culling method you apply to the object.Read/WriteYes
    2D87780EDraw Style:Line WidthReads 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/WriteYes
    2D87780FDraw Style:Point SizeReads 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/WriteYes
    2D877810Fog:FunctionReads or writes the blending factor you use to apply fog to an object.Read/WriteYes
    2D877811Fog:StartReads or writes the point at which the fog effects you apply to the object begin.Read/WriteYes
    2D877812Fog:EndReads 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/WriteYes
    2D877813Fog:DensityReads 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/WriteYes
    2D877814Fog:ColorReads 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/WriteYes
    2D877815Material:Color ModeReads or writes how the 3D object reacts to light. Materials only appear in lighted scenes.Read/WriteYes
    2D877816Material:AmbientReads or writes the RGBA color value of the object that the ambient light affects. Materials only appear in lighted scenes.Read/WriteYes
    2D877817Material:DiffuseReads 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/WriteYes
    2D877818Material:SpecularReads 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/WriteYes
    2D87781AMaterial:ShininessReads 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/WriteYes
    2D87781BSpecials:Anti-aliasingRead or writes whether the object is anti-aliased to smooth lines and edges that appear jagged.Read/WriteYes
    2D87781CSpecials:AutonormalizingRead or writes whether the vertex normals of the object automatically normalize to enhance rendering speed.Read/WriteYes
    2D87781DSpecials:Shade ModelReads or writes whether a color-filled object appears shaded with one color or multiple colors.Read/WriteYes
    2D877822Specials:Depth TestReads 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/WriteYes
    2D877823Specials:LightingReads or writes whether a 3D object appears lit.Read/WriteYes
    2D877824Specials:TexturingReads or writes whether a 3D object appears with a texture. This property must be set to On to apply textures to an object.Read/WriteYes
    2D877825Blending:Function:SourceReads or writes the blend factor you apply to the color values of the incoming fragment.Read/WriteYes
    2D877827Material:EmissionReads 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/WriteYes
    2D877828TransformationReads or writes the transformation you apply to the object.Read/WriteYes
    2D877829View Port:ModeReads or writes how to specify the size of the view port you use to view the scene.Read/WriteYes
    2D87782AView Port:View PortReads 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/WriteYes
    2D87782BDrawableReturns the drawable attribute applied to a 3D object. Drawable attributes include geometries and text. You must close this reference.Read OnlyYes
    2D87782CLine Stipple:ModeSets the mode for line stipple.Read/WriteYes
    2D87782DLine Stipple:FactorThe multiplier on the line stipple pattern. LabVIEW uses each bit factor number of times. Valid values range from 1 to 256, inclusive.Read/WriteYes
    2D87782ELine Stipple:PatternBit 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/WriteYes
    2D87782FBillboard:ModeSets the billboard mode for the 3D graph object. If the mode is No Billboarding, the object normal is set to default.Read OnlyYes
    2D877830Billboard:NormalThe 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 OnlyYes
    2D877831Billboard:AxisReturns the axis that rotates if Billboard:Mode is axial.Read OnlyYes
    2D877832Billboard:PositionsReturns the positions of the objects to be billboarded.Read OnlyYes
    2D877833PolygonOffset:ModeGets/sets the mode for polygon offset.Read/WriteYes
    2D877834PolygonOffset:FactorGets or sets the polygon offset factor. Changes to this property cause the polygon mode to change to off if it was inherited previously.Read/WriteYes
    2D877835PolygonOffset:UnitsGets or sets the polygon offset units. Changes to this property cause the polygon mode to change to off if it was inherited previously.Read/WriteYes
    2D877836VisibleRead/WriteYes

    Methods

    Show/Hide SceneObject Properties Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    SceneObject Methods Table
    Method ID Long Name (English) Description RTE
    2D877400Object:Add ObjectReads 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)
    2D877409Object:Object CountReturns the number of children directly under the scene object.Yes (Read/Write)
    2D877415Object:Remove ObjectRemoves a child object from the 3D object.Yes (Read/Write)
    2D877416Transformation:RotateRotates 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)
    2D877417Transformation:TranslateTranslates the object by the specified vector. This method performs a relative translation from the initial position of the object.Yes (Read/Write)
    2D877418Transformation:ScaleScales the object by the specified scaling factor. This method performs a relative scale from the current position of the object.Yes (Read/Write)
    2D877419Transformation:Set RotationRotates 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)
    2D87741ATransformation:Set TranslationTranslates the object by the specified vector. This method performs an absolute translation from the initial position of the object.Yes (Read/Write)
    2D87741BTransformation:Set ScaleScales the object by the specified scaling factor. This method performs an absolute scale from the current position of the object.Yes (Read/Write)
    2D87741CTransformation:ClearClears any transformations applied to the object and sets the transformation property to the identity matrix.Yes (Read/Write)
    2D87741DLight:Get StateReturns the state of the light.Yes (Read/Write)
    2D87741ELight:Set StateSets a state for the light.Yes (Read/Write)
    2D87741FClip Plane:Get StateReturns the state of the clip plane applied to an object in a 3D scene.Yes (Read/Write)
    2D877420Clip Plane:Set StateSets a state for the clip plane.Yes (Read/Write)
    2D877421Object:Get ObjectReturns a reference to a child object identified by the index you specify.Yes (Read/Write)
    2D877422Set GeometryYes
    2D877423Texture:Set TextureReads or writes the texture you apply to an object in a 3D scene.Yes (Read/Write)
    2D877424Texture:Remove TextureRemoves 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)
    2D877425Light:Add LightReads 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)
    2D877426Clip Plane:Add Clip PlaneAdds 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)
    2D877427Transformation:Get RotationReturns the Axis and Angle that define the rotation of the object.Yes (Read/Write)
    2D877428Transformation:Get TranslationReturns the translation of the object.Yes (Read/Write)
    2D877429Transformation:Get ScaleReturns the scale factors of the object.Yes (Read/Write)
    2D87742ALight:Get LightGets the child light owned by this object at the given index.Yes (Read/Write)
    2D87742BClip Plane:Get Clip PlaneGets the child clip plane owned by this object at the given index.Yes (Read/Write)
    2D87742CLight:Remove LightRemoves the given light owned by this object.Yes (Read/Write)
    2D87742DClip Plane:Remove Clip PlaneRemoves the given clip plane if it is owned by this object.Yes (Read/Write)
    2D87742ELight:Light CountReturns the number of lights directly owned by this object.Yes (Read/Write)
    2D87742FClip Plane:Clip Plane CountReturns the number of clip planes directly owned by this object.Yes (Read/Write)
    2D877430Object:Find ObjectTakes a 3D scene reference and an object name and returns the first object in the scene with a matching name.Yes (Read/Write)
    2D877431Set DrawableSpecifies 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)
    2D877432Set Billboard ParamsSets or updates parameters for billboarding.Yes (Read/Write)
    2D877433MeshifyYes
    2D877434Bounding:Get BoxYes
    2D877435Bounding:Get SphereYes

    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)
    LabVIEW 2018 More info to come.

    See Also

    Retrieved from "https://labviewwiki.org/w/index.php?title=SceneObject_class&oldid=26634"