Struct three::template::LightTemplate

source ·

pub struct LightTemplate {
    pub object: usize,
    pub color: Color,
    pub intensity: f32,
    pub sub_light: SubLightTemplate,
}

Expand description

Common information for instantiating the various types of lights.

See the module documentation for information on how templates are setup and how objects are added to the template.

Fields

object: usize

The object data for the light, given as an index into the objects array of the parent Template.

color: Color

The base color of the light.

intensity: f32

The intensity of the light.

sub_light: SubLightTemplate

The specific type of light represented by the template.

Implementations

source

impl LightTemplate

source

pub fn ambient(object: usize, color: Color, intensity: f32) -> LightTemplate

Creates a new template for an ambient light, analogous to Factory::ambient_light.

Examples

use three::template::{LightTemplate, ObjectTemplate, Template};

let mut template = Template::new();
template.objects.push(ObjectTemplate::new());
let light = LightTemplate::ambient(
    template.objects.len() - 1,
    three::color::RED,
    0.5,
);
template.lights.push(light);

source

pub fn directional(object: usize, color: Color, intensity: f32) -> LightTemplate

Creates a new template for a directional light, analogous to Factory::directional_light.

Examples

use three::template::{LightTemplate, ObjectTemplate, Template};

let mut template = Template::new();
template.objects.push(ObjectTemplate::new());
let light = LightTemplate::directional(
    template.objects.len() - 1,
    three::color::RED,
    0.5,
);
template.lights.push(light);

source

pub fn point(object: usize, color: Color, intensity: f32) -> LightTemplate

Creates a new template for a point light, analogous to Factory::point_light.

Examples

use three::template::{LightTemplate, ObjectTemplate, Template};

let mut template = Template::new();
template.objects.push(ObjectTemplate::new());
let light = LightTemplate::point(
    template.objects.len() - 1,
    three::color::RED,
    0.5,
);
template.lights.push(light);

source

pub fn hemisphere(
    object: usize,
    sky_color: Color,
    ground_color: Color,
    intensity: f32
) -> LightTemplate

Creates a new template for a hemisphere light, analogous to Factory::hemisphere_light.

Examples

use three::template::{LightTemplate, ObjectTemplate, Template};

let mut template = Template::new();
template.objects.push(ObjectTemplate::new());
let light = LightTemplate::hemisphere(
    template.objects.len() - 1,
    three::color::RED,
    three::color::BLUE,
    0.5,
);
template.lights.push(light);