Functions

Q3AmbientLight_GetData

( TQ3Status ) Q3AmbientLight_GetData (
    TQ3LightObject light,
    TQ3LightData *lightData
);

Discussion

Get the data for an ambient light.

Parameter Descriptions

light
The light to query.

lightData
Receives the data of the light.

function result: Success or failure of the operation.

Q3AmbientLight_New

( TQ3LightObject ) Q3AmbientLight_New (
    const TQ3LightData *lightData
);

Discussion

Create a new ambient light object.

Parameter Descriptions

lightData
The data for the light object.

function result: The new light object.

Q3AmbientLight_SetData

( TQ3Status ) Q3AmbientLight_SetData (
    TQ3LightObject light,
    const TQ3LightData *lightData
);

Discussion

Set the data for an ambient light.

Parameter Descriptions

light
The light to update.

lightData
The new data for the light.

function result: Success or failure of the operation.

Q3DirectionalLight_GetCastShadowsState

( TQ3Status ) Q3DirectionalLight_GetCastShadowsState (
    TQ3LightObject light,
    TQ3Boolean *castsShadows
);

Discussion

Get the cast-shadow state of a directional light.

Parameter Descriptions

light
The light to query.

castsShadows
Receives true or false as the light casts shadows.

function result: Success or failure of the operation.

Q3DirectionalLight_GetData

( TQ3Status ) Q3DirectionalLight_GetData (
    TQ3LightObject light,
    TQ3DirectionalLightData *directionalLightData
);

Discussion

Get the data for a directional light.

Parameter Descriptions

light
The light to query.

directionalLightData
Receives the data of the light.

function result: Success or failure of the operation.

Q3DirectionalLight_GetDirection

( TQ3Status ) Q3DirectionalLight_GetDirection (
    TQ3LightObject light,
    TQ3Vector3D *direction
);

Discussion

Get the direction of a directional light.

Parameter Descriptions

light
The light to query.

direction
Receives the direction of the light.

function result: Success or failure of the operation.

Q3DirectionalLight_New

( TQ3LightObject ) Q3DirectionalLight_New (
    const TQ3DirectionalLightData *directionalLightData
);

Discussion

Create a new directional light object.

Parameter Descriptions

directionalLightData
The data for the light object.

function result: The new light object.

Q3DirectionalLight_SetCastShadowsState

( TQ3Status ) Q3DirectionalLight_SetCastShadowsState (
    TQ3LightObject light,
    TQ3Boolean castsShadows
);

Discussion

Set the cast-shadow state of a directional light.

Parameter Descriptions

light
The light to update.

castsShadows
True or false as the light casts shadows.

function result: Success or failure of the operation.

Q3DirectionalLight_SetData

( TQ3Status ) Q3DirectionalLight_SetData (
    TQ3LightObject light,
    const TQ3DirectionalLightData *directionalLightData
);

Discussion

Set the data for a directional light.

Parameter Descriptions

light
The light to update.

directionalLightData
The new data for the light.

function result: Success or failure of the operation.

Q3DirectionalLight_SetDirection

( TQ3Status ) Q3DirectionalLight_SetDirection (
    TQ3LightObject light,
    const TQ3Vector3D *direction
);

Discussion

Set the direction of a directional light.

Parameter Descriptions

light
The light to update.

direction
The new direction for the light.

function result: Success or failure of the operation.

Q3Light_GetBrightness

( TQ3Status ) Q3Light_GetBrightness (
    TQ3LightObject light,
    float *brightness
);

Discussion

Get the brightness of a light.

Parameter Descriptions

light
The light to query.

brightness
Receives the brightness of the light.

function result: Success or failure of the operation.

Q3Light_GetColor

( TQ3Status ) Q3Light_GetColor (
    TQ3LightObject light,
    TQ3ColorRGB *color
);

Discussion

Get the color of a light.

Parameter Descriptions

light
The light to query.

color
Receives the color of the light.

function result: Success or failure of the operation.

Q3Light_GetData

( TQ3Status ) Q3Light_GetData (
    TQ3LightObject light,
    TQ3LightData *lightData
);

Discussion

Get the common state of a light.

Parameter Descriptions

light
The light to query.

lightData
Receives the common state of the light.

function result: Success or failure of the operation.

Q3Light_GetState

( TQ3Status ) Q3Light_GetState (
    TQ3LightObject light,
    TQ3Boolean *isOn
);

Discussion

Get the on/off state of a light.

Parameter Descriptions

light
The light to query.

isOn
Receives true/false as the light is on.

function result: Success or failure of the operation.

Q3Light_GetType

( TQ3ObjectType ) Q3Light_GetType (
    TQ3LightObject light
);

Discussion

Get the type of a light.

Returns kQ3ObjectTypeInvalid if the light type is unknown.

Parameter Descriptions

light
The light to query.

function result: The type of the light object.

Q3Light_SetBrightness

( TQ3Status ) Q3Light_SetBrightness (
    TQ3LightObject light,
    float brightness
);

Discussion

Set the brightness of a light.

Parameter Descriptions

light
The light to update.

brightness
The new brightness for the light.

function result: Success or failure of the operation.

Q3Light_SetColor

( TQ3Status ) Q3Light_SetColor (
    TQ3LightObject light,
    const TQ3ColorRGB *color
);

Discussion

Set the color of a light.

Parameter Descriptions

light
The light to update.

color
The new color for the light.

function result: Success or failure of the operation.

Q3Light_SetData

( TQ3Status ) Q3Light_SetData (
    TQ3LightObject light,
    const TQ3LightData *lightData
);

Discussion

Set the common state for a light.

Parameter Descriptions

light
The light to update.

lightData
The new common state for the light.

function result: Success or failure of the operation.

Q3Light_SetState

( TQ3Status ) Q3Light_SetState (
    TQ3LightObject light,
    TQ3Boolean isOn
);

Discussion

Set the on/off state for a light.

Parameter Descriptions

light
The light to update.

isOn
True or false as the light is on.

function result: Success or failure of the operation.

Q3PointLight_GetAttenuation

( TQ3Status ) Q3PointLight_GetAttenuation (
    TQ3LightObject light,
    TQ3AttenuationType *attenuation
);

Discussion

Get the attenuation of a point light.

Parameter Descriptions

light
The light to query.

attenuation
Receives the attenuation of the light.

function result: Success or failure of the operation.

Q3PointLight_GetCastShadowsState

( TQ3Status ) Q3PointLight_GetCastShadowsState (
    TQ3LightObject light,
    TQ3Boolean *castsShadows
);

Discussion

Get the cast-shadow state of a point light.

Parameter Descriptions

light
The light to query.

castsShadows
Receives true or false as the light casts shadows.

function result: Success or failure of the operation.

Q3PointLight_GetData

( TQ3Status ) Q3PointLight_GetData (
    TQ3LightObject light,
    TQ3PointLightData *pointLightData
);

Discussion

Get the data for a point light.

Parameter Descriptions

light
The light to query.

pointLightData
Receives the data of the light.

function result: Success or failure of the operation.

Q3PointLight_GetLocation

( TQ3Status ) Q3PointLight_GetLocation (
    TQ3LightObject light,
    TQ3Point3D *location
);

Discussion

Get the location of a point light.

Parameter Descriptions

light
The light to query.

location
Receives the location of the light.

function result: Success or failure of the operation.

Q3PointLight_GetRadius

( TQ3Status ) Q3PointLight_GetRadius (
    TQ3LightObject light,
    TQ3Float32 *radius
);

Discussion

Get the radius of a point light. By default, a point light has a radius of zero, but to achieve a fuzzy borders of shadows using certain renderers (ray tracers), you can set a radius on the light. The unit is related with the scale of the scene.

Parameter Descriptions

light
The light to query.

radius
Receives the radius of the light.

function result: Success or failure of the operation.

Q3PointLight_New

( TQ3LightObject ) Q3PointLight_New (
    const TQ3PointLightData *pointLightData
);

Discussion

Create a new point light object.

Parameter Descriptions

pointLightData
The data for the light object.

function result: The new light object.

Q3PointLight_SetAttenuation

( TQ3Status ) Q3PointLight_SetAttenuation (
    TQ3LightObject light,
    TQ3AttenuationType attenuation
);

Discussion

Set the attenuation of a point light.

Parameter Descriptions

light
The light to update.

attenuation
The new attenuation for the light.

function result: Success or failure of the operation.

Q3PointLight_SetCastShadowsState

( TQ3Status ) Q3PointLight_SetCastShadowsState (
    TQ3LightObject light,
    TQ3Boolean castsShadows
);

Discussion

Set the cast-shadow state of a point light.

Parameter Descriptions

light
The light to update.

castsShadows
True or false as the light casts shadows.

function result: Success or failure of the operation.

Q3PointLight_SetData

( TQ3Status ) Q3PointLight_SetData (
    TQ3LightObject light,
    const TQ3PointLightData *pointLightData
);

Discussion

Set the data for a point light.

Parameter Descriptions

light
The light to update.

pointLightData
The new data for the light.

function result: Success or failure of the operation.

Q3PointLight_SetLocation

( TQ3Status ) Q3PointLight_SetLocation (
    TQ3LightObject light,
    const TQ3Point3D *location
);

Discussion

Set the location of a point light.

Parameter Descriptions

light
The light to update.

location
The new location for the light.

function result: Success or failure of the operation.

Q3PointLight_SetRadius

( TQ3Status ) Q3PointLight_SetRadius (
    TQ3LightObject light,
    TQ3Float32 radius
);

Discussion

Set the radius of a point light. By default, a point light has a radius of zero, but to achieve a fuzzy borders of shadows using certain renderers (ray tracers), you can set a radius on the light. The unit is related with the scale of the scene.

Parameter Descriptions

light
The light to update.

attenuation
The new radius for the light.

function result: Success or failure of the operation.

Q3SpotLight_GetAttenuation

( TQ3Status ) Q3SpotLight_GetAttenuation (
    TQ3LightObject light,
    TQ3AttenuationType *attenuation
);

Discussion

Get the attenuation of a spot light.

Parameter Descriptions

light
The light to query.

attenuation
Receives the attenuation of the light.

function result: Success or failure of the operation.

Q3SpotLight_GetCastShadowsState

( TQ3Status ) Q3SpotLight_GetCastShadowsState (
    TQ3LightObject light,
    TQ3Boolean *castsShadows
);

Discussion

Get the cast-shadow state of a spot light.

Parameter Descriptions

light
The light to query.

castsShadows
Receives true or false as the light casts shadows.

function result: Success or failure of the operation.

Q3SpotLight_GetData

( TQ3Status ) Q3SpotLight_GetData (
    TQ3LightObject light,
    TQ3SpotLightData *spotLightData
);

Discussion

Get the data for a spot light.

Parameter Descriptions

light
The light to query.

spotLightData
Receives the data of the light.

function result: Success or failure of the operation.

Q3SpotLight_GetDirection

( TQ3Status ) Q3SpotLight_GetDirection (
    TQ3LightObject light,
    TQ3Vector3D *direction
);

Discussion

Get the direction of a spot light.

Parameter Descriptions

light
The light to query.

direction
Receives the direction of the light.

function result: Success or failure of the operation.

Q3SpotLight_GetFallOff

( TQ3Status ) Q3SpotLight_GetFallOff (
    TQ3LightObject light,
    TQ3FallOffType *fallOff
);

Discussion

Get the fall off of a spot light.

Parameter Descriptions

light
The light to query.

fallOff
Receives the fall off value of the light.

function result: Success or failure of the operation.

Q3SpotLight_GetHotAngle

( TQ3Status ) Q3SpotLight_GetHotAngle (
    TQ3LightObject light,
    float *hotAngle
);

Discussion

Get the hot angle of a spot light.

Parameter Descriptions

light
The light to query.

hotAngle
Receives the hot angle of the light.

function result: Success or failure of the operation.

Q3SpotLight_GetLocation

( TQ3Status ) Q3SpotLight_GetLocation (
    TQ3LightObject light,
    TQ3Point3D *location
);

Discussion

Get the location of a spot light.

Parameter Descriptions

light
The light to query.

location
Receives the location of the light.

function result: Success or failure of the operation.

Q3SpotLight_GetOuterAngle

( TQ3Status ) Q3SpotLight_GetOuterAngle (
    TQ3LightObject light,
    float *outerAngle
);

Discussion

Get the outer angle of a spot light.

Parameter Descriptions

light
The light to query.

outerAngle
Receives the outer angle of the light.

function result: Success or failure of the operation.

Q3SpotLight_New

( TQ3LightObject ) Q3SpotLight_New (
    const TQ3SpotLightData *spotLightData
);

Discussion

Create a new spot light object.

Parameter Descriptions

spotLightData
The data for the light object.

function result: The new light object.

Q3SpotLight_SetAttenuation

( TQ3Status ) Q3SpotLight_SetAttenuation (
    TQ3LightObject light,
    TQ3AttenuationType attenuation
);

Discussion

Set the attenuation for a spot light.

Parameter Descriptions

light
The light to update.

attenuation
The new attenuation for the light.

function result: Success or failure of the operation.

Q3SpotLight_SetCastShadowsState

( TQ3Status ) Q3SpotLight_SetCastShadowsState (
    TQ3LightObject light,
    TQ3Boolean castsShadows
);

Discussion

Set the cast-shadow state of a spot light.

Parameter Descriptions

light
The light to update.

castsShadows
True or false as the light casts shadows.

function result: Success or failure of the operation.

Q3SpotLight_SetData

( TQ3Status ) Q3SpotLight_SetData (
    TQ3LightObject light,
    const TQ3SpotLightData *spotLightData
);

Discussion

Set the data for a spot light.

Parameter Descriptions

light
The light to update.

spotLightData
The new data for the light.

function result: Success or failure of the operation.

Q3SpotLight_SetDirection

( TQ3Status ) Q3SpotLight_SetDirection (
    TQ3LightObject light,
    const TQ3Vector3D *direction
);

Discussion

Set the direction of a spot light.

Parameter Descriptions

light
The light to update.

direction
The new direction for the light.

function result: Success or failure of the operation.

Q3SpotLight_SetFallOff

( TQ3Status ) Q3SpotLight_SetFallOff (
    TQ3LightObject light,
    TQ3FallOffType fallOff
);

Discussion

Set the fall off of a spot light.

Parameter Descriptions

light
The light to update.

fallOff
The new fall off value for the light.

function result: Success or failure of the operation.

Q3SpotLight_SetHotAngle

( TQ3Status ) Q3SpotLight_SetHotAngle (
    TQ3LightObject light,
    float hotAngle
);

Discussion

Set the hot angle of a spot light.

Parameter Descriptions

light
The light to update.

hotAngle
The new hot angle for the light.

function result: Success or failure of the operation.

Q3SpotLight_SetLocation

( TQ3Status ) Q3SpotLight_SetLocation (
    TQ3LightObject light,
    const TQ3Point3D *location
);

Discussion

Set the location for a spot light.

Parameter Descriptions

light
The light to update.

location
The new location for the light.

function result: Success or failure of the operation.

Q3SpotLight_SetOuterAngle

( TQ3Status ) Q3SpotLight_SetOuterAngle (
    TQ3LightObject light,
    float outerAngle
);

Discussion

Set the outer angle of a spot light.

Parameter Descriptions

light
The light to update.

outerAngle
The new outer angle for the light.

function result: Success or failure of the operation.