#include <DbLight.h>
Public Types inherited from Detailed Description
This class represents a placeholder for all generic light properties. Corresponding C++ library: SCENEOE
<group OdDb_Classes>
Member Enumeration Documentation
◆ GlyphDisplayType
◆ LampColorPreset
Lamp color presets.
◆ LampColorType
◆ PhysicalIntensityMethod
Constructor & Destructor Documentation
◆ OdDbLight()
| OdDbLight::OdDbLight | ( | ) |
Default constructor for the OdDbLight class. Creates an object with default properties of the OdDbLightImpl object.
Member Function Documentation
◆ drawableType()
|
virtual |
Retrieves the type of this drawable.
Reimplemented from OdGiDrawable.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to a filer object from which to read the data.
- Returns
- Returns the filer status.
- Remarks
- This function is called by dwgIn() to allow the object to read its data. When overriding this function:
- Call the parent class's dwgInFields(pFiler).
- If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned.
- Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written.
- Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [out] Pointer to a filer object to which to write the data.
- Returns
- Returns the filer status.
- Remarks
- This function is called by dwgOut() to allow the object to write its data. When overriding this function:
- Call the parent class's dwgOutFields(pFiler).
- Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ dxfInFields()
|
virtual |
Reads the .dxf file data of this object.
- Parameters
-
pFiler [in] Pointer to a filer object from which to read the data.
- Returns
- Returns the filer status.
- Remarks
- This function is called by dxfIn() to allow the object to read its data. When overriding this function:
- Call the parent class's dwgInFields(pFiler).
- If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned.
- Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written.
- Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dxfOutFields()
|
virtual |
Writes the .dxf file data of this object.
- Parameters
-
pFiler [out] Pointer to a filer object to which to write the data.
- Returns
- Returns the filer status.
- Remarks
- This function is called by dxfOut() to allow the object to write its data. When overriding this function:
- Call the parent class's dxfOutFields(pFiler).
- Call the OdDbDxfFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ falloffAngle()
| double OdDbLight::falloffAngle | ( | ) | const |
Retrieves the cone angle that produces the light falloff.
◆ glyphDisplay()
| GlyphDisplayType OdDbLight::glyphDisplay | ( | ) | const |
Retrieves the glyph display type of this light.
◆ hasTarget()
| bool OdDbLight::hasTarget | ( | ) | const |
Checks whether this light displays a target grip to orient this light.
◆ hotspotAngle()
| double OdDbLight::hotspotAngle | ( | ) | const |
Retrieves the cone angle that produces the brightest part of the beam (hotspot) of this light.
◆ illuminanceDistance()
| double OdDbLight::illuminanceDistance | ( | ) | const |
Retrieves the illuminance distance of the light.
◆ intensity()
| double OdDbLight::intensity | ( | ) | const |
Retrieves the intensity of this light.
◆ isOn()
| bool OdDbLight::isOn | ( | ) | const |
Checks whether this light is enabled.
- Returns
- true if this light is turned on, false otherwise.
◆ isPlottable()
| bool OdDbLight::isPlottable | ( | ) | const |
Checks whether this light is shown during plotting.
- Returns
- true if this light is plottable, false otherwise.
◆ lampColorPreset()
| LampColorPreset OdDbLight::lampColorPreset | ( | ) | const |
Retrieves the preset lamp color of this light.
◆ lampColorRGB()
| OdGiColorRGB OdDbLight::lampColorRGB | ( | ) | const |
Retrieves the RGB value of the light's lamp color.
◆ lampColorTemp()
| double OdDbLight::lampColorTemp | ( | ) | const |
Retrieves the Kelvin color temperature of the light if the lamp color type is kKelvin.
◆ lampColorType()
| LampColorType OdDbLight::lampColorType | ( | ) | const |
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()
| const OdGiLightAttenuation & OdDbLight::lightAttenuation | ( | ) | const |
Retrieves the attenuation parameters of this light.
◆ lightColor()
| OdCmColor OdDbLight::lightColor | ( | ) | const |
Retrieves the color of this light.
◆ lightDirection()
| OdGeVector3d OdDbLight::lightDirection | ( | ) | const |
Retrieves the direction of a distant light.
◆ lightType()
| OdGiDrawable::DrawableType OdDbLight::lightType | ( | ) | const |
Retrieves the type of this light.
◆ name()
| OdString OdDbLight::name | ( | ) | const |
Retrieves the light name.
◆ ODDB_DECLARE_MEMBERS()
| OdDbLight::ODDB_DECLARE_MEMBERS | ( | OdDbLight | ) |
◆ physicalIntensity()
| double OdDbLight::physicalIntensity | ( | ) | const |
Retrieves the physical intensity of the light. The units are based on the physical intensity method (candela, lumen or lux).
◆ physicalIntensityMethod()
| PhysicalIntensityMethod OdDbLight::physicalIntensityMethod | ( | ) | const |
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()
| OdGePoint3d OdDbLight::position | ( | ) | const |
Retrieves the position for point light and spot light sources.
◆ resultingColor()
| OdCmColor OdDbLight::resultingColor | ( | ) | const |
Retrieves the final color of the light as a result of mixing the lamp color and the filter color.
◆ setGlyphDisplay()
| void OdDbLight::setGlyphDisplay | ( | GlyphDisplayType | type | ) |
Specifies the display type of the glyph for this light.
- Parameters
-
type [in] Glyph display type.
◆ setHasTarget()
| void OdDbLight::setHasTarget | ( | bool | bTarget | ) |
Specifies whether this light should display a target grip to orient this light.
- Parameters
-
bTarget [in] Flag that specifies whether this light should display a target grip.
◆ setHotspotAndFalloff()
| void OdDbLight::setHotspotAndFalloff | ( | double | hotspot, |
| double | falloff | ||
| ) |
Specifies the hotspot and falloff for the cone of the directional light.
- Parameters
-
hotspot [in] Hotspot cone angle, in radians. Defines the brightest part of the spot light beam. falloff [in] Falloff angle, in radians. Defines the full cone of light.
◆ setIlluminanceDistance()
| void OdDbLight::setIlluminanceDistance | ( | double | illumDistance | ) |
Specifies the illuminance distance of the light.
- Parameters
-
illumDistance [in] Illuminance distance of the light.
◆ setIntensity()
| void OdDbLight::setIntensity | ( | double | intensity | ) |
Specifies the intensity of this light.
- Parameters
-
intensity [in] Light intensity.
◆ setIsPlottable()
| void OdDbLight::setIsPlottable | ( | bool | plot | ) |
Specifies whether this light is shown during plotting.
- Parameters
-
plot [in] Flag that specifies whether this light is plottable.
◆ setLampColorPreset()
| void OdDbLight::setLampColorPreset | ( | LampColorPreset | colorPreset | ) |
Sets the lamp color of this light from a preset.
- Parameters
-
colorPreset [in] Preset lamp color.
◆ setLampColorRGB()
| void OdDbLight::setLampColorRGB | ( | const OdGiColorRGB & | color | ) |
Sets the lamp color of this light as an RGB color value.
- Parameters
-
color [in] RGB lamp color.
◆ setLampColorTemp()
| void OdDbLight::setLampColorTemp | ( | double | colorTemp | ) |
Sets the Kelvin color temperature of the light.
- Parameters
-
colorTemp [in] Lamp color temperature in the range [1000 .. 20000] Kelvin.
◆ setLampColorType()
| void OdDbLight::setLampColorType | ( | LampColorType | colorType | ) |
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).
- Parameters
-
colorType [in] Lamp color type.
◆ setLightAttenuation()
| void OdDbLight::setLightAttenuation | ( | const OdGiLightAttenuation & | params | ) |
Specifies the attenuation parameters for this light.
- Parameters
-
params [in] Attenuation parameters.
◆ setLightColor()
Specifies the color of this light.
- Parameters
-
color [in] Light color.
◆ setLightDirection()
| void OdDbLight::setLightDirection | ( | const OdGeVector3d & | lightvec | ) |
Specifies the direction of a distant light.
- Parameters
-
vec [in] Light direction.
◆ setLightType()
| void OdDbLight::setLightType | ( | OdGiDrawable::DrawableType | type | ) |
Sets the type of this light.
- Parameters
-
type [in] Light type.
◆ setName()
◆ setOn()
| void OdDbLight::setOn | ( | bool | value | ) |
Switches this light on or off.
- Parameters
-
value [in] Flag that turns this light on or off.
◆ setPhysicalIntensity()
| void OdDbLight::setPhysicalIntensity | ( | double | physIntensity | ) |
Specifies the physical intensity of the light.
- Parameters
-
physIntensity [in] Physical intensity of the light. The units are based on the physical intensity method (candela, lumen or lux).
◆ setPhysicalIntensityMethod()
| void OdDbLight::setPhysicalIntensityMethod | ( | PhysicalIntensityMethod | physIntMethod | ) |
Specifies the physical intensity method for this light that indicates how the physical intensity of the light is specified.
- Parameters
-
physIntMethod [in] Physical intensity method.
◆ setPosition()
| void OdDbLight::setPosition | ( | const OdGePoint3d & | pos | ) |
Specifies the position for point light and spot light sources.
- Parameters
-
pos [in] Light source position.
◆ setShadowParameters()
| void OdDbLight::setShadowParameters | ( | const OdGiShadowParameters & | params | ) |
Specifies the shadow parameters for this light.
- Parameters
-
params [in] Shadow parameters.
◆ setTargetLocation()
| void OdDbLight::setTargetLocation | ( | const OdGePoint3d & | newVal | ) |
Specifies the target location of a light.
- Parameters
-
newVal [in] Location of the target. Must differ from the light position.
◆ setWebFile()
Specifies the full path to the file that stores the light's goniometric data (.ies file).
- Parameters
-
webFile [in] Full path to a web file.
◆ setWebRotation()
| void OdDbLight::setWebRotation | ( | const OdGeVector3d & | rotation | ) |
Specifies the rotation offset used to orient the goniometric data relative to the light orientation. The angle for each axis is 0.0.
- Parameters
-
rotation [in] Vector that defines the rotation offset.
◆ shadowParameters()
| const OdGiShadowParameters & OdDbLight::shadowParameters | ( | ) | const |
Retrieves the shadow parameters of this light.
◆ subErase()
|
virtual |
Called as the first operation when this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Returns
- Returns eOk if and only if erase() is to continue.
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase. When overriding this function:
- If the parent class's subErase() returns anything other than eOk, immediately return it.
- If other actions are required before erase, do them.
- Return eOk. If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns anything other than eOk. Also the m_bHighlighted member of this object is set to false if 'erasing' is true.
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subHighlight()
|
virtual |
Highlights this object.
- Parameters
-
bDoIt [in] A flag value that determines whether highlighting is enabled (if true) or disabled (if false). This flag can switch the highlighting on or off. pSubId [in] A full subentity path that identifies the subentity to be highlighted.
highlightAll [in] Indicates whether to highlight in all viewports.
Reimplemented from OdDbEntity.
◆ subSetAttributes()
|
virtual |
Sets the vectorization attributes of this object, and returns its attribute flags.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object from and to which the attributes are to be set.
- Remarks
- This function is called by the vectorization framework, prior to calling subWorldDraw() or subViewportDraw(), to set the attributes for an object.
- See also
- <link OdDbLight::subSetAttributes@OdGiDrawableTraits*@const, subSetAttributesFlags() method>
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Applies the specified 3D transformation matrix to this entity.
- Parameters
-
xfm [in] 3D transformation matrix.
- Returns
- eOk if successful, or an appropriate error code otherwise.
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Creates a viewport-dependent geometric representation of this object.
- Parameters
-
pVd [in] Pointer to the OdGiViewportDraw interface.
- Remarks
- Causes OdGiDrawable to describe its geometry to the specified OdGiViewportDraw object.
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Creates a viewport-independent geometric representation of this object.
- Parameters
-
pWd [in] Pointer to the OdGiWorldDraw interface.
- Returns
- Returns true if and only if the geometric representation can be generated in a viewport-independent manner.
Reimplemented from OdDbEntity.
◆ targetLocation()
| OdGePoint3d OdDbLight::targetLocation | ( | ) | const |
Retrieves the target location of a light.
- Returns
- Target location of the light as an OdGePoint3d instance.
◆ webFile()
| OdString OdDbLight::webFile | ( | ) | const |
Retrieves the full path to the file that stores the light's goniometric data (.ies file).
◆ webRotation()
| OdGeVector3d OdDbLight::webRotation | ( | ) | const |
Retrieves the rotation offset used to orient the goniometric data relative to the light orientation.
The documentation for this class was generated from the following file: