CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdGiSkyParameters Class Reference

#include <GiLightTraits.h>

Public Member Functions

 OdGiSkyParameters ()
 
bool operator== (const OdGiSkyParameters &params) const
 
void setIllumination (bool enable)
 
bool illumination () const
 
void setIntensityFactor (double intensity)
 
double intensityFactor () const
 
void setHaze (double haze)
 
double haze () const
 
void setHorizonHeight (double height)
 
double horizonHeight () const
 
void setHorizonBlur (double blur)
 
double horizonBlur () const
 
void setGroundColor (const OdCmEntityColor &color)
 
OdCmEntityColor groundColor () const
 
void setNightColor (const OdCmEntityColor &color)
 
OdCmEntityColor nightColor () const
 
void setAerialPerspective (bool apply)
 
bool aerialPerspective () const
 
void setVisibilityDistance (double distance)
 
double visibilityDistance () const
 
void setDiskScale (double scale)
 
double diskScale () const
 
void setGlowIntensity (double intensity)
 
double glowIntensity () const
 
void setDiskIntensity (double intensity)
 
double diskIntensity () const
 
void setSolarDiskSamples (OdUInt16 samples)
 
OdUInt16 solarDiskSamples () const
 
void setSunDirection (const OdGeVector3d &sundir)
 
const OdGeVector3dsunDirection () const
 
void setRedBlueShift (double redBlueShift)
 
double redBlueShift () const
 
void setSaturation (double saturation)
 
double saturation () const
 

Detailed Description

This class contains all sky properties for OdDbSun objects.

See also
TD_Gi

<group OdGi_Classes>

Definition at line 498 of file GiLightTraits.h.

Constructor & Destructor Documentation

◆ OdGiSkyParameters()

OdGiSkyParameters::OdGiSkyParameters ( )
inline

Definition at line 571 of file GiLightTraits.h.

Member Function Documentation

◆ aerialPerspective()

bool OdGiSkyParameters::aerialPerspective ( ) const
inline

Definition at line 672 of file GiLightTraits.h.

◆ diskIntensity()

double OdGiSkyParameters::diskIntensity ( ) const
inline

Definition at line 704 of file GiLightTraits.h.

◆ diskScale()

double OdGiSkyParameters::diskScale ( ) const
inline

Definition at line 688 of file GiLightTraits.h.

◆ glowIntensity()

double OdGiSkyParameters::glowIntensity ( ) const
inline

Definition at line 696 of file GiLightTraits.h.

◆ groundColor()

OdCmEntityColor OdGiSkyParameters::groundColor ( ) const
inline

Definition at line 656 of file GiLightTraits.h.

◆ haze()

double OdGiSkyParameters::haze ( ) const
inline

Definition at line 632 of file GiLightTraits.h.

◆ horizonBlur()

double OdGiSkyParameters::horizonBlur ( ) const
inline

Definition at line 648 of file GiLightTraits.h.

◆ horizonHeight()

double OdGiSkyParameters::horizonHeight ( ) const
inline

Definition at line 640 of file GiLightTraits.h.

◆ illumination()

bool OdGiSkyParameters::illumination ( ) const
inline

Definition at line 616 of file GiLightTraits.h.

◆ intensityFactor()

double OdGiSkyParameters::intensityFactor ( ) const
inline

Definition at line 624 of file GiLightTraits.h.

◆ nightColor()

OdCmEntityColor OdGiSkyParameters::nightColor ( ) const
inline

Definition at line 664 of file GiLightTraits.h.

◆ operator==()

bool OdGiSkyParameters::operator== ( const OdGiSkyParameters params) const
inline

Definition at line 591 of file GiLightTraits.h.

◆ redBlueShift()

double OdGiSkyParameters::redBlueShift ( ) const
inline

Definition at line 728 of file GiLightTraits.h.

◆ saturation()

double OdGiSkyParameters::saturation ( ) const
inline

Definition at line 736 of file GiLightTraits.h.

◆ setAerialPerspective()

void OdGiSkyParameters::setAerialPerspective ( bool  apply)
inline

Definition at line 668 of file GiLightTraits.h.

◆ setDiskIntensity()

void OdGiSkyParameters::setDiskIntensity ( double  intensity)
inline

Definition at line 700 of file GiLightTraits.h.

◆ setDiskScale()

void OdGiSkyParameters::setDiskScale ( double  scale)
inline

Definition at line 684 of file GiLightTraits.h.

◆ setGlowIntensity()

void OdGiSkyParameters::setGlowIntensity ( double  intensity)
inline

Definition at line 692 of file GiLightTraits.h.

◆ setGroundColor()

void OdGiSkyParameters::setGroundColor ( const OdCmEntityColor color)
inline

Definition at line 652 of file GiLightTraits.h.

◆ setHaze()

void OdGiSkyParameters::setHaze ( double  haze)
inline

Definition at line 628 of file GiLightTraits.h.

◆ setHorizonBlur()

void OdGiSkyParameters::setHorizonBlur ( double  blur)
inline

Definition at line 644 of file GiLightTraits.h.

◆ setHorizonHeight()

void OdGiSkyParameters::setHorizonHeight ( double  height)
inline

Definition at line 636 of file GiLightTraits.h.

◆ setIllumination()

void OdGiSkyParameters::setIllumination ( bool  enable)
inline

Definition at line 612 of file GiLightTraits.h.

◆ setIntensityFactor()

void OdGiSkyParameters::setIntensityFactor ( double  intensity)
inline

Definition at line 620 of file GiLightTraits.h.

◆ setNightColor()

void OdGiSkyParameters::setNightColor ( const OdCmEntityColor color)
inline

Definition at line 660 of file GiLightTraits.h.

◆ setRedBlueShift()

void OdGiSkyParameters::setRedBlueShift ( double  redBlueShift)
inline

Definition at line 724 of file GiLightTraits.h.

◆ setSaturation()

void OdGiSkyParameters::setSaturation ( double  saturation)
inline

Definition at line 732 of file GiLightTraits.h.

◆ setSolarDiskSamples()

void OdGiSkyParameters::setSolarDiskSamples ( OdUInt16  samples)
inline

Definition at line 708 of file GiLightTraits.h.

◆ setSunDirection()

void OdGiSkyParameters::setSunDirection ( const OdGeVector3d sundir)
inline

Definition at line 716 of file GiLightTraits.h.

◆ setVisibilityDistance()

void OdGiSkyParameters::setVisibilityDistance ( double  distance)
inline

Definition at line 676 of file GiLightTraits.h.

◆ solarDiskSamples()

OdUInt16 OdGiSkyParameters::solarDiskSamples ( ) const
inline

Definition at line 712 of file GiLightTraits.h.

◆ sunDirection()

const OdGeVector3d & OdGiSkyParameters::sunDirection ( ) const
inline

Definition at line 720 of file GiLightTraits.h.

◆ visibilityDistance()

double OdGiSkyParameters::visibilityDistance ( ) const
inline

Definition at line 680 of file GiLightTraits.h.


The documentation for this class was generated from the following file: