CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdTrVisBackgroundDef Struct Reference

#include <TrVisBackgroundDef.h>

Public Types

enum  Flags { kEnableBackground = (1 << 0) , kCameraBackground = (1 << 1) , kShadedBackground = (1 << 2) , kFOVOverride = (1 << 3) }
 

Public Member Functions

void resetFlags (OdUInt16 nFlags=0)
 
void setDefault ()
 
void enableBackground (bool bSet)
 
bool isBackgroundEnabled () const
 
void linkBackgroundToCamera (bool bSet)
 
bool isBackgroundLinkedToCamera () const
 
void setShadedBackground (bool bSet)
 
bool isShadedBackground () const
 
void enableFOVOverride (bool bSet)
 
bool isFOVOverridden () const
 
void setBackgroundStream (const OdTrVisFlatMetafileContainerPtr pStream)
 
OdTrVisFlatMetafileContainerPtr backgroundStream () const
 
bool hasBackgroundStream () const
 
void setBaseProgramId (OdTrVisProgramId baseProgramId)
 
OdTrVisProgramId baseProgramId () const
 
bool hasBaseProgramId () const
 
void setCameraRotationAngles (double longRot, double latRot)
 
void cameraRotationAngles (double &longRot, double &latRot) const
 
double longitudeRotationAngle () const
 
double latitudeRotationAngle () const
 
void setFOVOverrideAngle (double fovAngle)
 
double fovOverrideAngle () const
 
void setBackgroundRadius (double bkgndRad)
 
double backgroundRadius () const
 
bool operator== (const OdTrVisBackgroundDef &bkgnd) const
 
bool operator!= (const OdTrVisBackgroundDef &bkgnd) const
 

Static Public Member Functions

static bool compareNoStream (const OdTrVisBackgroundDef &bkgnd1, const OdTrVisBackgroundDef &bkgnd2)
 

Public Attributes

OdUInt16 m_flags
 
OdTrVisFlatMetafileContainerPtr m_pStream
 
OdTrVisProgramId m_baseProgramId
 
double m_longRot
 
double m_latRot
 
double m_fovAngle
 
double m_bkgndRad
 

Detailed Description

<group ExRender_Windows_Classes>

Definition at line 35 of file TrVisBackgroundDef.h.

Member Enumeration Documentation

◆ Flags

Enumerator
kEnableBackground 
kCameraBackground 
kShadedBackground 
kFOVOverride 

Definition at line 38 of file TrVisBackgroundDef.h.

Member Function Documentation

◆ backgroundRadius()

double OdTrVisBackgroundDef::backgroundRadius ( ) const
inline

Definition at line 103 of file TrVisBackgroundDef.h.

◆ backgroundStream()

OdTrVisFlatMetafileContainerPtr OdTrVisBackgroundDef::backgroundStream ( ) const
inline

Definition at line 87 of file TrVisBackgroundDef.h.

◆ baseProgramId()

OdTrVisProgramId OdTrVisBackgroundDef::baseProgramId ( ) const
inline

Definition at line 91 of file TrVisBackgroundDef.h.

◆ cameraRotationAngles()

void OdTrVisBackgroundDef::cameraRotationAngles ( double & longRot,
double & latRot ) const
inline

Definition at line 95 of file TrVisBackgroundDef.h.

◆ compareNoStream()

static bool OdTrVisBackgroundDef::compareNoStream ( const OdTrVisBackgroundDef & bkgnd1,
const OdTrVisBackgroundDef & bkgnd2 )
inlinestatic

Definition at line 138 of file TrVisBackgroundDef.h.

◆ enableBackground()

void OdTrVisBackgroundDef::enableBackground ( bool bSet)
inline

Definition at line 74 of file TrVisBackgroundDef.h.

◆ enableFOVOverride()

void OdTrVisBackgroundDef::enableFOVOverride ( bool bSet)
inline

Definition at line 83 of file TrVisBackgroundDef.h.

◆ fovOverrideAngle()

double OdTrVisBackgroundDef::fovOverrideAngle ( ) const
inline

Definition at line 100 of file TrVisBackgroundDef.h.

◆ hasBackgroundStream()

bool OdTrVisBackgroundDef::hasBackgroundStream ( ) const
inline

Definition at line 88 of file TrVisBackgroundDef.h.

◆ hasBaseProgramId()

bool OdTrVisBackgroundDef::hasBaseProgramId ( ) const
inline

Definition at line 92 of file TrVisBackgroundDef.h.

◆ isBackgroundEnabled()

bool OdTrVisBackgroundDef::isBackgroundEnabled ( ) const
inline

Definition at line 75 of file TrVisBackgroundDef.h.

◆ isBackgroundLinkedToCamera()

bool OdTrVisBackgroundDef::isBackgroundLinkedToCamera ( ) const
inline

Definition at line 78 of file TrVisBackgroundDef.h.

◆ isFOVOverridden()

bool OdTrVisBackgroundDef::isFOVOverridden ( ) const
inline

Definition at line 84 of file TrVisBackgroundDef.h.

◆ isShadedBackground()

bool OdTrVisBackgroundDef::isShadedBackground ( ) const
inline

Definition at line 81 of file TrVisBackgroundDef.h.

◆ latitudeRotationAngle()

double OdTrVisBackgroundDef::latitudeRotationAngle ( ) const
inline

Definition at line 97 of file TrVisBackgroundDef.h.

◆ linkBackgroundToCamera()

void OdTrVisBackgroundDef::linkBackgroundToCamera ( bool bSet)
inline

Definition at line 77 of file TrVisBackgroundDef.h.

◆ longitudeRotationAngle()

double OdTrVisBackgroundDef::longitudeRotationAngle ( ) const
inline

Definition at line 96 of file TrVisBackgroundDef.h.

◆ operator!=()

bool OdTrVisBackgroundDef::operator!= ( const OdTrVisBackgroundDef & bkgnd) const
inline

Definition at line 121 of file TrVisBackgroundDef.h.

◆ operator==()

bool OdTrVisBackgroundDef::operator== ( const OdTrVisBackgroundDef & bkgnd) const
inline

Definition at line 105 of file TrVisBackgroundDef.h.

◆ resetFlags()

void OdTrVisBackgroundDef::resetFlags ( OdUInt16 nFlags = 0)
inline

Definition at line 60 of file TrVisBackgroundDef.h.

◆ setBackgroundRadius()

void OdTrVisBackgroundDef::setBackgroundRadius ( double bkgndRad)
inline

Definition at line 102 of file TrVisBackgroundDef.h.

◆ setBackgroundStream()

void OdTrVisBackgroundDef::setBackgroundStream ( const OdTrVisFlatMetafileContainerPtr pStream)
inline

Definition at line 86 of file TrVisBackgroundDef.h.

◆ setBaseProgramId()

void OdTrVisBackgroundDef::setBaseProgramId ( OdTrVisProgramId baseProgramId)
inline

Definition at line 90 of file TrVisBackgroundDef.h.

◆ setCameraRotationAngles()

void OdTrVisBackgroundDef::setCameraRotationAngles ( double longRot,
double latRot )
inline

Definition at line 94 of file TrVisBackgroundDef.h.

◆ setDefault()

void OdTrVisBackgroundDef::setDefault ( )
inline

Definition at line 64 of file TrVisBackgroundDef.h.

◆ setFOVOverrideAngle()

void OdTrVisBackgroundDef::setFOVOverrideAngle ( double fovAngle)
inline

Definition at line 99 of file TrVisBackgroundDef.h.

◆ setShadedBackground()

void OdTrVisBackgroundDef::setShadedBackground ( bool bSet)
inline

Definition at line 80 of file TrVisBackgroundDef.h.

Member Data Documentation

◆ m_baseProgramId

OdTrVisProgramId OdTrVisBackgroundDef::m_baseProgramId

Definition at line 54 of file TrVisBackgroundDef.h.

◆ m_bkgndRad

double OdTrVisBackgroundDef::m_bkgndRad

Definition at line 58 of file TrVisBackgroundDef.h.

◆ m_flags

OdUInt16 OdTrVisBackgroundDef::m_flags

Definition at line 50 of file TrVisBackgroundDef.h.

◆ m_fovAngle

double OdTrVisBackgroundDef::m_fovAngle

Definition at line 58 of file TrVisBackgroundDef.h.

◆ m_latRot

double OdTrVisBackgroundDef::m_latRot

Definition at line 56 of file TrVisBackgroundDef.h.

◆ m_longRot

double OdTrVisBackgroundDef::m_longRot

Definition at line 56 of file TrVisBackgroundDef.h.

◆ m_pStream

OdTrVisFlatMetafileContainerPtr OdTrVisBackgroundDef::m_pStream

Definition at line 52 of file TrVisBackgroundDef.h.


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