Libraries.Game.Graphics.Painter3D Documentation

Inherits from: Libraries.Language.Object, Libraries.Game.Disposable

Summary

Actions Summary Table

ActionsDescription
Begin(Libraries.Game.Graphics.Camera camera)This action will set the Painter3D so it is prepared to accept models for rendering on the screen.
Begin()This action will set the Painter3D so that it is ready to accept models to be rendered on the screen.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Dispose()
End()This action will make the Painter3D finish rendering, causing any objects provided by the Render() action to be rendered on the screen.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetCamera()This action will return the camera that is currently being used by the Painter3D.
GetEnvironment()This action will return the environment that is currently being used by the Painter3D.
GetHashCode()This action gets the hash code for an object.
GetSkybox()This action will return the Skybox that is currently being used by the Painter3D.
IsRendering()This action will return whether or not the Painter3D is currently rendering objects.
Render(Libraries.Game.Graphics.Model model)
SetCamera(Libraries.Game.Graphics.Camera camera)This action will set the camera for the Painter3D.
SetEnvironment(Libraries.Game.Graphics.Environment environment)This action will set the environment for the Painter3D.
SetSkybox(Libraries.Game.Graphics.Skybox skybox)This action will set the Skybox for the Painter3D.

Actions Documentation

Begin(Libraries.Game.Graphics.Camera camera)

This action will set the Painter3D so it is prepared to accept models for rendering on the screen. The models will be rendered on screen as they are visible from the provided camera.

Parameters

Begin()

This action will set the Painter3D so that it is ready to accept models to be rendered on the screen. The Painter3D must have a camera set using the SetCamera action before Begin is called.

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Dispose()

End()

This action will make the Painter3D finish rendering, causing any objects provided by the Render() action to be rendered on the screen. After this action is called, the Begin() action must be called again before providing more models to be drawn with Render().

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetCamera()

This action will return the camera that is currently being used by the Painter3D.

Return

Libraries.Game.Graphics.Camera:

GetEnvironment()

This action will return the environment that is currently being used by the Painter3D.

Return

Libraries.Game.Graphics.Environment:

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetSkybox()

This action will return the Skybox that is currently being used by the Painter3D.

Return

Libraries.Game.Graphics.Skybox:

IsRendering()

This action will return whether or not the Painter3D is currently rendering objects.

Return

boolean:

Render(Libraries.Game.Graphics.Model model)

Parameters

SetCamera(Libraries.Game.Graphics.Camera camera)

This action will set the camera for the Painter3D. When rendering, the Painter3D will draw objects on the screen as they are visible from the currently set camera.

Parameters

SetEnvironment(Libraries.Game.Graphics.Environment environment)

This action will set the environment for the Painter3D. When rendering, the Painter3D will draw objects on the screen using the lighting from the currently set environment.

Parameters

SetSkybox(Libraries.Game.Graphics.Skybox skybox)

This action will set the Skybox for the Painter3D. When rendering, the Painter3D will draw the Skybox behind all other items on the screen.

Parameters