CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | List of all members
OdGiShadowParameters Class Reference

#include <GiLightTraits.h>

Public Types

enum  ShadowType { kShadowsRayTraced = 0, kShadowMaps, kAreaSampled }
 
enum  ExtendedLightShape {
  kLinear = 0, kRectangle, kDisk, kCylinder,
  kSphere
}
 

Public Member Functions

 OdGiShadowParameters ()
 
 OdGiShadowParameters (const OdGiShadowParameters &parms)
 
OdGiShadowParametersoperator= (const OdGiShadowParameters &parms)
 
bool operator== (const OdGiShadowParameters &parms) const
 
bool operator!= (const OdGiShadowParameters &parms) const
 
void setShadowsOn (bool on)
 
bool shadowsOn () const
 
void setShadowType (ShadowType typ)
 
ShadowType shadowType () const
 
bool setShadowMapSize (OdUInt16 sz)
 
OdUInt16 shadowMapSize () const
 
bool setShadowMapSoftness (OdUInt8 soft)
 
OdUInt8 shadowMapSoftness () const
 
bool setShadowSamples (OdUInt16 nSamples)
 
OdUInt16 shadowSamples () const
 
void setShapeVisibility (bool bVisibility)
 
bool shapeVisibility () const
 
void setExtendedLightShape (ExtendedLightShape lightShape)
 
ExtendedLightShape extendedLightShape () const
 
bool setExtendedLightLength (double dLength)
 
double extendedLightLength () const
 
bool setExtendedLightWidth (double dWidth)
 
double extendedLightWidth () const
 
bool setExtendedLightRadius (double dRadius)
 
double extendedLightRadius () const
 
void save (OdGsFiler *pFiler) const
 
void load (OdGsFiler *pFiler)
 

Detailed Description

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 119 of file GiLightTraits.h.

Member Enumeration Documentation

◆ ExtendedLightShape

Enumerator
kLinear 
kRectangle 
kDisk 
kCylinder 
kSphere 

Definition at line 137 of file GiLightTraits.h.

◆ ShadowType

Enumerator
kShadowsRayTraced 
kShadowMaps 
kAreaSampled 

Definition at line 130 of file GiLightTraits.h.

Constructor & Destructor Documentation

◆ OdGiShadowParameters() [1/2]

OdGiShadowParameters::OdGiShadowParameters ( )
inline

Definition at line 213 of file GiLightTraits.h.

◆ OdGiShadowParameters() [2/2]

OdGiShadowParameters::OdGiShadowParameters ( const OdGiShadowParameters parms)
inline

Definition at line 227 of file GiLightTraits.h.

Member Function Documentation

◆ extendedLightLength()

double OdGiShadowParameters::extendedLightLength ( ) const
inline

Definition at line 370 of file GiLightTraits.h.

◆ extendedLightRadius()

double OdGiShadowParameters::extendedLightRadius ( ) const
inline

Definition at line 392 of file GiLightTraits.h.

◆ extendedLightShape()

OdGiShadowParameters::ExtendedLightShape OdGiShadowParameters::extendedLightShape ( ) const
inline

Definition at line 359 of file GiLightTraits.h.

◆ extendedLightWidth()

double OdGiShadowParameters::extendedLightWidth ( ) const
inline

Definition at line 381 of file GiLightTraits.h.

◆ load()

void OdGiShadowParameters::load ( OdGsFiler pFiler)
inline

Definition at line 187 of file GiLightTraits.h.

◆ operator!=()

bool OdGiShadowParameters::operator!= ( const OdGiShadowParameters parms) const
inline

Definition at line 270 of file GiLightTraits.h.

◆ operator=()

OdGiShadowParameters & OdGiShadowParameters::operator= ( const OdGiShadowParameters parms)
inline

Definition at line 241 of file GiLightTraits.h.

◆ operator==()

bool OdGiShadowParameters::operator== ( const OdGiShadowParameters parms) const
inline

Definition at line 256 of file GiLightTraits.h.

◆ save()

void OdGiShadowParameters::save ( OdGsFiler pFiler) const
inline

Definition at line 175 of file GiLightTraits.h.

◆ setExtendedLightLength()

bool OdGiShadowParameters::setExtendedLightLength ( double  dLength)
inline

Definition at line 364 of file GiLightTraits.h.

◆ setExtendedLightRadius()

bool OdGiShadowParameters::setExtendedLightRadius ( double  dRadius)
inline

Definition at line 386 of file GiLightTraits.h.

◆ setExtendedLightShape()

void OdGiShadowParameters::setExtendedLightShape ( OdGiShadowParameters::ExtendedLightShape  lightShape)
inline

Definition at line 354 of file GiLightTraits.h.

◆ setExtendedLightWidth()

bool OdGiShadowParameters::setExtendedLightWidth ( double  dWidth)
inline

Definition at line 375 of file GiLightTraits.h.

◆ setShadowMapSize()

bool OdGiShadowParameters::setShadowMapSize ( OdUInt16  sz)
inline

Definition at line 304 of file GiLightTraits.h.

◆ setShadowMapSoftness()

bool OdGiShadowParameters::setShadowMapSoftness ( OdUInt8  soft)
inline

Definition at line 322 of file GiLightTraits.h.

◆ setShadowSamples()

bool OdGiShadowParameters::setShadowSamples ( OdUInt16  nSamples)
inline

Definition at line 333 of file GiLightTraits.h.

◆ setShadowsOn()

void OdGiShadowParameters::setShadowsOn ( bool  on)
inline

Definition at line 284 of file GiLightTraits.h.

◆ setShadowType()

void OdGiShadowParameters::setShadowType ( ShadowType  typ)
inline

Definition at line 294 of file GiLightTraits.h.

◆ setShapeVisibility()

void OdGiShadowParameters::setShapeVisibility ( bool  bVisibility)
inline

Definition at line 344 of file GiLightTraits.h.

◆ shadowMapSize()

OdUInt16 OdGiShadowParameters::shadowMapSize ( ) const
inline

Definition at line 317 of file GiLightTraits.h.

◆ shadowMapSoftness()

OdUInt8 OdGiShadowParameters::shadowMapSoftness ( ) const
inline

Definition at line 328 of file GiLightTraits.h.

◆ shadowSamples()

OdUInt16 OdGiShadowParameters::shadowSamples ( ) const
inline

Definition at line 339 of file GiLightTraits.h.

◆ shadowsOn()

bool OdGiShadowParameters::shadowsOn ( ) const
inline

Definition at line 289 of file GiLightTraits.h.

◆ shadowType()

OdGiShadowParameters::ShadowType OdGiShadowParameters::shadowType ( ) const
inline

Definition at line 299 of file GiLightTraits.h.

◆ shapeVisibility()

bool OdGiShadowParameters::shapeVisibility ( ) const
inline

Definition at line 349 of file GiLightTraits.h.


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