CreatePlane

CreatePlane()

Syntax

Result = CreatePlane(#Mesh, TileSizeX, TileSizeZ, TileCountX, TileCountZ, TextureRepeatCountX, TextureRepeatCountZ)

Description

Create a new plane mesh.

Parameters

#Mesh The number to identify the new mesh. #PB_Any can be used to auto-generate this number.

TileSizeX X size of the a single tile, in world unit, of the plane. A tile is the base component of a plane. A plane can be composed of lot of tiles to make it bigger and allow deformation.

TileSizeZ Z size of the a single tile, in world unit, of the plane. A tile is the base component of a plane. A plane can be composed of lot of tiles to make it bigger and allow deformation.

TileCountX Number of tiles used to create the X axis of the plane.

TileCountZ Number of tiles used to create the Z axis of the plane.

TextureRepeatCountX Number of time the texture applied to the plane will be repeated on the X axis. To apply the whole texture all over the X axis, just use 1.

TextureRepeatCountZ Number of time the texture applied to the plane will be repeated on the Z axis. To apply the whole texture all over the Z axis, just use 1.

Return value

Returns nonzero if the mesh was created successfully and zero if there was an error. If #PB_Any was used as the #Mesh parameter then the new generated number is returned on success.

Example

  InitEngine3D() 
  InitSprite() 
  
  OpenWindow(0, 0, 0, 640, 480, "Plane example", #PB_Window_SystemMenu | #PB_Window_ScreenCentered)
  OpenWindowedScreen(WindowID(0), 0, 0, 640, 480, 0, 0, 0)
  
  ; Light
  CreateLight(#PB_Any, RGB(25, 25, 180), -5, 10, 5, #PB_Light_Point)
  
  ; Camera
  CreateCamera(0, 0, 0, 100, 100)
  MoveCamera(0, 2, 1, 3, #PB_Absolute | #PB_Local)
  CameraLookAt(0, 0, 0, 0)
  
  ; Create the plane and attach it to the scene
  CreatePlane(0, 2, 2, 1, 1, 0, 0)
  CreateEntity(0, MeshID(0), #PB_Material_None)
  
  Repeat
    RenderWorld()
    FlipBuffers()
  Until WaitWindowEvent(1) = #PB_Event_CloseWindow

See Also

FreeMesh(), CreateSphere(), CreateMesh(), CreateCube(), CreatePlane(), CreateLine3D()

Supported OS

All

<- CreateMesh() - Mesh Index - CreateSphere() ->

#Mesh	The number to identify the new mesh. #PB_Any can be used to auto-generate this number.
TileSizeX	X size of the a single tile, in world unit, of the plane. A tile is the base component of a plane. A plane can be composed of lot of tiles to make it bigger and allow deformation.
TileSizeZ	Z size of the a single tile, in world unit, of the plane. A tile is the base component of a plane. A plane can be composed of lot of tiles to make it bigger and allow deformation.
TileCountX	Number of tiles used to create the X axis of the plane.
TileCountZ	Number of tiles used to create the Z axis of the plane.
TextureRepeatCountX	Number of time the texture applied to the plane will be repeated on the X axis. To apply the whole texture all over the X axis, just use 1.
TextureRepeatCountZ	Number of time the texture applied to the plane will be repeated on the Z axis. To apply the whole texture all over the Z axis, just use 1.