Class PrimitiveVisual

View Source

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

A class encapsulating the property map of the primitive visual.


                
C#

                

                    
Copy

                    

                

            
public class PrimitiveVisual : VisualMap, IDisposable
Inheritance
System.Object
VisualMap
PrimitiveVisual
Implements
System.IDisposable

Constructors

View Source

PrimitiveVisual()

Constructor.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PrimitiveVisual()
API Level: 3

Properties

View Source

BevelPercentage

Gets or sets determines how bevelled the cuboid should be, based off the smallest dimension.
Bevel percentage ranges from 0.0 to 1.0. It affects the ratio of the outer face widths to the width of the overall cube.
If not specified, the default is 0.0f (no bevel).
Applies to:

  • PrimitiveVisualShapeType.BevelledCube
    The range is from 0.0f to 1.0f.
    Optional.
Declaration

                
C#

                

                    
Copy

                    

                

            
public float BevelPercentage { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

BevelSmoothness

Gets or sets descriptions of how smooth the bevelled edges should be.
If not specified, the default is 0.0f (sharp edges).
Applies to:

  • PrimitiveVisualShapeType.BevelledCube
    The range is from 0.0f to 1.0f.
    Optional.
Declaration

                
C#

                

                    
Copy

                    

                

            
public float BevelSmoothness { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

LightPosition

Gets or sets the position, in the stage space, of the point light that applies lighting to the model.
This is based off the stage's dimensions, so using the width and the height of the stage halved will correspond to the center, and using all zeroes will place the light at the top-left corner.
If not specified, the default is an offset outwards from the center of the screen.
Applies to all shapes.
Optional.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Vector3 LightPosition { get; set; }
Property Value
Type Description
Vector3
API Level: 3
View Source

MixColor

Gets or sets the color of the shape.
If not specified, the default is Color (0.5, 0.5, 0.5, 1.0).
Applies to all shapes.
Optional.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Color MixColor { get; set; }
Property Value
Type Description
Color
API Level: 3
View Source

ScaleBottomRadius

Gets or sets the scale of the radius of the bottom circle of a conical frustum.
If not specified, the default is 1.5f.
Applies to: - PrimitiveVisualShapeType.ConicalFrustrum

  • PrimitiveVisualShapeType.Cone
    Only values greater than or equal to 0.0f are accepted.
    Optional.
Declaration

                
C#

                

                    
Copy

                    

                

            
public float ScaleBottomRadius { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

ScaleDimensions

Gets or sets the dimensions of a cuboid. Scales in the same fashion as a 9-patch image.
If not specified, the default is Vector3.One.
Applies to:

  • PrimitiveVisualShapeType.Cube
  • PrimitiveVisualShapeType.Octahedron
  • PrimitiveVisualShapeType.BevelledCube
    Each Vector3 parameter should be greater than or equal to 0.0f.
    Optional.
Declaration

                
C#

                

                    
Copy

                    

                

            
public Vector3 ScaleDimensions { get; set; }
Property Value
Type Description
Vector3
API Level: 3
View Source

ScaleHeight

Gets or sets the scale of the height of a conic.
If not specified, the default is 3.0f.
Applies to:

  • PrimitiveVisualShapeType.ConicalFrustrum
  • PrimitiveVisualShapeType.Cone
  • PrimitiveVisualShapeType.Cylinder
    Only values greater than or equal to 0.0f are accepted.
    Optional.
Declaration

                
C#

                

                    
Copy

                    

                

            
public float ScaleHeight { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

ScaleRadius

Gets or sets the scale of the radius of a cylinder.
If not specified, the default is 1.0f.
Applies to:

  • PrimitiveVisualShapeType.Cylinder
    Only values greater than or equal to 0.0f are accepted.
    Optional.
Declaration

                
C#

                

                    
Copy

                    

                

            
public float ScaleRadius { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

ScaleTopRadius

Gets or sets the scale of the radius of the top circle of a conical frustum.
If not specified, the default is 1.0f.
Applies to: - PrimitiveVisualShapeType.ConicalFrustrum
Only values greater than or equal to 0.0f are accepted.
Optional.

Declaration

                
C#

                

                    
Copy

                    

                

            
public float ScaleTopRadius { get; set; }
Property Value
Type Description
System.Single
API Level: 3
View Source

Shape

Gets or sets the specific shape to render.
If not specified, the default is PrimitiveVisualShapeType.Sphere.
Optional.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PrimitiveVisualShapeType Shape { get; set; }
Property Value
Type Description
PrimitiveVisualShapeType
API Level: 3
View Source

Slices

Gets or sets the number of slices as you go around the shape.
For spheres and conical frustums, this determines how many divisions there are as you go around the object.
If not specified, the default is 128.
The range is from 1 to 255.
Optional.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int Slices { get; set; }
Property Value
Type Description
Int32
API Level: 3
View Source

Stacks

Gets or sets the number of stacks as you go down the shape.
For spheres, 'stacks' determines how many layers there are as you go down the object.
If not specified, the default is 128.
The range is from 1 to 255.
Optional.

Declaration

                
C#

                

                    
Copy

                    

                

            
public int Stacks { get; set; }
Property Value
Type Description
Int32
API Level: 3

Methods

View Source

ComposingPropertyMap()

Compose the out visual map.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void ComposingPropertyMap()
Overrides
API Level: 3

Implements

System.IDisposable