VgEngine::VgVisibilityRamp Struct Reference

Describes a visibility ramp function that modifies the visibility, depending on the distance from the camera. More...

Public Member Functions
	VgVisibilityRamp ()
	VgVisibilityRamp (float pStartVisibleDistance, float pFullyVisibleDistance, float pStartInvisibleDistance, float pFullyInvisibleDistance)
void	operator= (const VgVisibilityRamp &pOther)
bool	operator== (const VgVisibilityRamp &pOther) const
bool	operator!= (const VgVisibilityRamp &pOther) const

Public Attributes
float	mStartVisibleDistance
	Distance in meters at which it starts becoming visible. More...
float	mFullyVisibleDistance
	Distance in meters at which it is fully visible. More...
float	mStartInvisibleDistance
	Distance in meters at which it starts to become invisible. More...
float	mFullyInvisibleDistance
	Distance in meters at which it is fully invisible. More...

Detailed Description

Describes a visibility ramp function that modifies the visibility, depending on the distance from the camera.

Version

2.0.9263

Constructor & Destructor Documentation

VgEngine::VgVisibilityRamp::VgVisibilityRamp ( )

inline

VgEngine::VgVisibilityRamp::VgVisibilityRamp ( float  pStartVisibleDistance, float  pFullyVisibleDistance, float  pStartInvisibleDistance, float  pFullyInvisibleDistance  )

inline

Member Function Documentation

bool VgEngine::VgVisibilityRamp::operator!= ( const VgVisibilityRamp &  pOther ) const

inline

void VgEngine::VgVisibilityRamp::operator= ( const VgVisibilityRamp &  pOther )

inline

References mFullyInvisibleDistance, mFullyVisibleDistance, mStartInvisibleDistance, and mStartVisibleDistance.

bool VgEngine::VgVisibilityRamp::operator== ( const VgVisibilityRamp &  pOther ) const

inline

References mFullyInvisibleDistance, mFullyVisibleDistance, mStartInvisibleDistance, and mStartVisibleDistance.

Member Data Documentation

float VgEngine::VgVisibilityRamp::mFullyInvisibleDistance

Distance in meters at which it is fully invisible.

By default +infinity. If set to a very large value, it will never fade out.

The default value of this property is 0.0.

Referenced by operator=(), and operator==().

float VgEngine::VgVisibilityRamp::mFullyVisibleDistance

Distance in meters at which it is fully visible.

If set to 0.0, it is always visble when you are close.

The default value of this property is 0.0.

Referenced by operator=(), and operator==().

float VgEngine::VgVisibilityRamp::mStartInvisibleDistance

Distance in meters at which it starts to become invisible.

The default value of this property is 0.0.

Referenced by operator=(), and operator==().

float VgEngine::VgVisibilityRamp::mStartVisibleDistance

Distance in meters at which it starts becoming visible.

If set to 0.0, it is always visble no matter how close you are.

The default value of this property is 0.0.

Referenced by operator=(), and operator==().

---

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

• VgEngine/VgTypes.h