Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    GeometricPrimitive.Plane Class

    Namespace: Stride.Graphics.GeometricPrimitives
    Assembly: Stride.Graphics.dll

    A plane primitive.

    System.Object → GeometricPrimitive.Plane
    Derived from GeometricPrimitive.Plane:

    public static class Plane
    Name Description
    Methods
    New(GraphicsDevice, Single, Single, Int32, Int32, Single, Single, Boolean, Boolean, NormalDirection)

    Creates a Plane primitive on the X/Y plane with a normal equal to -UnitZ.

    New(Single, Single, Int32, Int32, Single, Single, Boolean, Boolean, NormalDirection)

    Creates a Plane primitive on the X/Y plane with a normal equal to -UnitZ.

    | Improve this Doc View Source

    Methods


    New(GraphicsDevice, Single, Single, Int32, Int32, Single, Single, Boolean, Boolean, NormalDirection)

    Creates a Plane primitive on the X/Y plane with a normal equal to -UnitZ.

    public static GeometricPrimitive New(GraphicsDevice device, float sizeX = 1F, float sizeY = 1F, int tessellationX = 1, int tessellationY = 1, float uFactor = 1F, float vFactor = 1F, bool generateBackFace = false, bool toLeftHanded = false, NormalDirection normalDirection = NormalDirection.UpZ)
    Parameters
    Type Name Description
    GraphicsDevice device

    The device.

    System.Single sizeX

    The size X.

    System.Single sizeY

    The size Y.

    System.Int32 tessellationX

    The tessellation, as the number of quads per X axis.

    System.Int32 tessellationY

    The tessellation, as the number of quads per Y axis.

    System.Single uFactor

    Scale U coordinates between 0 and the values of this parameter.

    System.Single vFactor

    Scale V coordinates 0 and the values of this parameter.

    System.Boolean generateBackFace

    Add a back face to the plane

    System.Boolean toLeftHanded

    if set to true vertices and indices will be transformed to left handed. Default is false.

    NormalDirection normalDirection

    The direction of the plane normal

    Returns
    Type Description
    GeometricPrimitive

    A Plane primitive.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    tessellation;tessellation must be > 0


    New(Single, Single, Int32, Int32, Single, Single, Boolean, Boolean, NormalDirection)

    Creates a Plane primitive on the X/Y plane with a normal equal to -UnitZ.

    public static GeometricMeshData<VertexPositionNormalTexture> New(float sizeX = 1F, float sizeY = 1F, int tessellationX = 1, int tessellationY = 1, float uFactor = 1F, float vFactor = 1F, bool generateBackFace = false, bool toLeftHanded = false, NormalDirection normalDirection = NormalDirection.UpZ)
    Parameters
    Type Name Description
    System.Single sizeX

    The size X.

    System.Single sizeY

    The size Y.

    System.Int32 tessellationX

    The tessellation, as the number of quads per X axis.

    System.Int32 tessellationY

    The tessellation, as the number of quads per Y axis.

    System.Single uFactor

    Scale U coordinates between 0 and the values of this parameter.

    System.Single vFactor

    Scale V coordinates 0 and the values of this parameter.

    System.Boolean generateBackFace

    Add a back face to the plane

    System.Boolean toLeftHanded

    if set to true vertices and indices will be transformed to left handed. Default is false.

    NormalDirection normalDirection

    The direction of the plane normal

    Returns
    Type Description
    GeometricMeshData<VertexPositionNormalTexture>

    A Plane primitive.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    tessellation;tessellation must be > 0


    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation