Libraries.Game.Graphics.Environment

The Environment class is a set of Attributes that specifically handles lighting.

Adds a PointLight to this environment.

This action will add an array of lights to the environment. Each light must be usable by the Environment. The Environment can use DirectionalLight and PointLight.

This action will add ambient lighting to the Environment.

This action will add all of the attribute objects stored in the given Attributes object to this Attributes object.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array
    use Libraries.Game.Graphics.AmbientLight
    use Libraries.Game.Graphics.DirectionalLight
    use Libraries.Game.Graphics.Attributes

    class Main is Game

        Model sphere

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            sphere:LoadSphere(3, 3, 3, color:Orange())
            Add(sphere)

            AmbientLight ambient
            ambient:SetColor(0.4, 0.4, 0.4, 1)
            SetAmbientLight(ambient)

            DirectionalLight light
            light:SetColor(0.8, 0.8, 0.8, 1)
            light:SetDirection(0, -1, 1)
            Add(light)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = sphere:GetMaterials()

            integer counter = 0

            repeat while counter < materialsArray:GetSize()
                Material material = materialsArray:Get(counter)

                Attributes newAttributes

                ColorAttribute specularAttribute
                specular

Adds a DirectionalLight to this environment.

This action will add an Attribute to this Attributes object.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array
    use Libraries.Game.Graphics.AmbientLight
    use Libraries.Game.Graphics.DirectionalLight

    class Main is Game

        Model sphere

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            sphere:LoadSphere(3, 3, 3, color:Orange())
            Add(sphere)

            AmbientLight ambient
            ambient:SetColor(0.4, 0.4, 0.4, 1)
            SetAmbientLight(ambient)

            DirectionalLight light
            light:SetColor(0.8, 0.8, 0.8, 1)
            light:SetDirection(0, -1, 1)
            Add(light)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = sphere:GetMaterials()

            integer counter = 0

            repeat while counter < materialsArray:GetSize()
                Material material = materialsArray:Get(counter)

                ColorAttribute colorAttribute
                color

This action will add a light to the environment. It can accept any light that inherits from Light as a parameter, but the Environment can only use lights that are either DirectionalLight or PointLight. If the given light can't be used by the Environment, an error will be alerted.

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

This action will return whether the Environment currently contains any lighting elements. An Environment that contains no lighting elements will be ignored during rendering.

This action will disable the given type (or multiple types, if combined using the Or operation of the BitwiseOperations class) in this Attributes object.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

This action removes all Attribute objects from this Attributes object.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0

            repeat while counter < materialsArray:GetSize()
                Material material = materialsArray:Get(counter)

                // This will remove all the Attribute objects being used by the Material.
                material:Empty()

                counter = counter + 1
            end
        end
    end

This action will enable the given type (or multiple types, if combined using the Or operation of the BitwiseOperations class) in this Attributes object.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

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)

Gets the AmbientLight set for this environment. If none is set, will return undefined.

This action returns the Attribute stored within this Attributes object with the given type. If no such Attribute has been stored in this object, it will return undefined.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

This action returns the array of Attribute objects contained within this Attributes object.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array
    use Libraries.Game.Graphics.Attribute

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

This action returns an iterator containing all of the DirectionLights in the environment.

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

This action returns an integer mask containing the combined integer code values of each Attribute type present in this Attributes object. The codes are combined using bitwise Or operations.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array
    use Libraries.Compute.BitwiseOperations

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            BitwiseOperations bits
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

This action returns the number of Attribute objects that are currently part of this Attributes object.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0

            repeat while counter < materialsArray:GetSize()
                Material material = materialsArray:Get(counter)

                output "Material " + counter + " has " + material:GetSize() + " attribute(s)."

                counter = counter + 1
            end
        end
    end

This action will identify the index of a given Attribute type. If the Attributes object does not currently have the given type, -1 will be returned.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array
    use Libraries.Game.Graphics.Attribute

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

This action tests if the given Attribute type is currently a part of this Attributes object. A boolean value is returned based on the result.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

This action will remove the given DirectionalLight from the Environment. If the light was not present in the Environment before using this action, it will have no effect.

This action will remove an Attribute of the given Attribute type from this Attributes object, or remove multiple Attribute objects if the integer code provided is the combined values of multiple Attribute types.

Example Code

use Libraries.Game.Game
    use Libraries.Game.Graphics.Model
    use Libraries.Game.Graphics.Color
    use Libraries.Game.Graphics.Material
    use Libraries.Game.Graphics.ColorAttribute
    use Libraries.Containers.Array

    class Main is Game

        action Main
            StartGame()
        end

        action CreateGame
            Color color

            Model box
            box:LoadBox(1, 1, 1, color:Purple())
            Add(box)

            // The Material class inherits from Attributes. Whenever a user wants to
            // manipulate the attributes being used in a game, they will most likely
            // be working with a Material object.
            Array<Material> materialsArray = box:GetMaterials()

            output "The box is using " + materialsArray:GetSize() + " material(s)."

            integer counter = 0
            ColorAttribute colorAttribute

            // We store the Diffuse value from the ColorAttribute class. Each type
            // of attribute has a unique code that identifies the Attribute. This
            // particular code represents the Diffuse color attribute.
            integer diffuseValue = color

This action will remove a light from the environment. The given light must be usable by the Environment, i.e. it is a DirectionalLight or PointLight. If the given light was not a part of the Environment before using Remove, nothing will happen.

This action will remove each light that is present in the given array from the Environment. Each light must be usable by the Environment, i.e., it is a DirectionalLight or PointLight. Otherwise, an error will be alerted. Lights that are present in the array but not in the Environment will have no effect.

This action will remove the given PointLight from the Environment. If the light was not present in the Environment before using this action, it will have no effect.

This action will remove all ambient lighting from this Environment.

This action will remove all ambient lighting from this Environment.