OdDbLight Class

Class Hierarchy

Syntax

C++

class OdDbLight : public OdDbEntity;

File

DbLight.h

Description

This class represents a placeholder for all generic light properties. Corresponding C++ library: SCENEOE

Group

OdDb Classes

Public Methods

	Name	Description
	OdDbLight	Default constructor for the OdDbLight class. Creates an object with default properties of the OdDbLightImpl object.

OdDbLight Enumerations

	Name	Description
	GlyphDisplayType	Display types for glyphs.
	LampColorPreset	Lamp color presets.
	LampColorType	The lamp color type.
	PhysicalIntensityMethod

OdDbLight Methods

	Name	Description
	drawableType	Retrieves the type of this drawable.
	dwgInFields	Reads the .dwg file data of this object.
	dwgOutFields	Writes the .dwg file data of this object.
	dxfInFields	Reads the .dxf file data of this object.
	dxfOutFields	Writes the .dxf file data of this object.
	falloffAngle	Retrieves the cone angle that produces the light falloff.
	glyphDisplay	Retrieves the glyph display type of this light.
	hasTarget	Checks whether this light displays a target grip to orient this light.
	hotspotAngle	Retrieves the cone angle that produces the brightest part of the beam (hotspot) of this light.
	illuminanceDistance	Retrieves the illuminance distance of the light.
	intensity	Retrieves the intensity of this light.
	isOn	Checks whether this light is enabled.
	isPlottable	Checks whether this light is shown during plotting.
	lampColorPreset	Retrieves the preset lamp color of this light.
	lampColorRGB	Retrieves the RGB value of the light's lamp color.
	lampColorTemp	Retrieves the Kelvin color temperature of the light if the lamp color type is kKelvin.
	lampColorType	Retrieves the lamp color type of the light that indicates how the lamp color of the light is specified (Kelvin color temperature or a preset lamp color).
	lightAttenuation	Retrieves the attenuation parameters of this light.
	lightColor	Retrieves the color of this light.
	lightDirection	Retrieves the direction of a distant light.
	lightType	Retrieves the type of this light.
	name	Retrieves the light name.
	ODDB_DECLARE_MEMBERS
	physicalIntensity	Retrieves the physical intensity of the light. The units are based on the physical intensity method (candela, lumen or lux).
	physicalIntensityMethod	Retrieves the physical intensity method of this light that indicates how the physical intensity of the light is calculated (by peak intensity, by flux or by illuminance).
	position	Retrieves the position for point light and spot light sources.
	resultingColor	Retrieves the final color of the light as a result of mixing the lamp color and the filter color.
	setGlyphDisplay	Specifies the display type of the glyph for this light.
	setHasTarget	Specifies whether this light should display a target grip to orient this light.
	setHotspotAndFalloff	Specifies the hotspot and falloff for the cone of the directional light.
	setIlluminanceDistance	Specifies the illuminance distance of the light.
	setIntensity	Specifies the intensity of this light.
	setIsPlottable	Specifies whether this light is shown during plotting.
	setLampColorPreset	Sets the lamp color of this light from a preset.
	setLampColorRGB	Sets the lamp color of this light as an RGB color value.
	setLampColorTemp	Sets the Kelvin color temperature of the light.
	setLampColorType	Specifies the lamp color type of the light that indicates how the lamp color of the light is specified (Kelvin color temperature or a preset lamp color).
	setLightAttenuation	Specifies the attenuation parameters for this light.
	setLightColor	Specifies the color of this light.
	setLightDirection	Specifies the direction of a distant light.
	setLightType	Sets the type of this light.
	setName	Sets a light name.
	setOn	Switches this light on or off.
	setPhysicalIntensity	Specifies the physical intensity of the light.
	setPhysicalIntensityMethod	Specifies the physical intensity method for this light that indicates how the physical intensity of the light is specified.
	setPosition	Specifies the position for point light and spot light sources.
	setShadowParameters	Specifies the shadow parameters for this light.
	setTargetLocation	Specifies the target location of a light.
	setWebFile	Specifies the full path to the file that stores the light's goniometric data (.ies file).
	setWebRotation	Specifies the rotation offset used to orient the goniometric data relative to the light orientation. The angle for each axis is 0.0.
	shadowParameters	Retrieves the shadow parameters of this light.
	subErase	Called as the first operation when this object is being erased or unerased.
	subGetClassID	overridables
	subHighlight	Highlights this object.
	subSetAttributes	Sets the vectorization attributes of this object, and returns its attribute flags.
	subTransformBy	Applies the specified 3D transformation matrix to this entity.
	subViewportDraw	Creates a viewport-dependent geometric representation of this object.
	subWorldDraw	Creates a viewport-independent geometric representation of this object.
	targetLocation	Retrieves the target location of a light.
	webFile	Retrieves the full path to the file that stores the light's goniometric data (.ies file).
	webRotation	Retrieves the rotation offset used to orient the goniometric data relative to the light orientation.

Send feedback about this topic