OdGiImageBackgroundTraits Class Reference

#include <GiEnvironment.h>

Inheritance diagram for OdGiImageBackgroundTraits:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiImageBackgroundTraits)
virtual void	setImageFilename (const OdString &filename)=0
virtual const OdString &	imageFilename () const =0
virtual void	setFitToScreen (bool bFitToScreen)=0
virtual bool	fitToScreen () const =0
virtual void	setMaintainAspectRatio (bool bMaintainAspectRatio)=0
virtual bool	maintainAspectRatio () const =0
virtual void	setUseTiling (bool bUseTiling)=0
virtual bool	useTiling () const =0
virtual void	setXOffset (double xOffset)=0
virtual double	xOffset () const =0
virtual void	setYOffset (double yOffset)=0
virtual double	yOffset () const =0
virtual void	setXScale (double xScale)=0
virtual double	xScale () const =0
virtual void	setYScale (double yScale)=0
virtual double	yScale () const =0
Public Member Functions inherited from OdGiDrawableTraits
	ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class represents traits that are related to the image-based backgrounds.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1399 of file GiEnvironment.h.

Member Function Documentation

fitToScreen()

virtual bool OdGiImageBackgroundTraits::fitToScreen ( ) const

pure virtual

Checks whether image-based background should be fit to screen.

Returns

true if background is fit to screen, false otherwise.

imageFilename()

virtual const OdString & OdGiImageBackgroundTraits::imageFilename ( ) const

pure virtual

Retrieves image file name.

Returns

full path to an image file.

maintainAspectRatio()

virtual bool OdGiImageBackgroundTraits::maintainAspectRatio ( ) const

pure virtual

Checks whether image-based background maintains aspect ratio.

Returns

true if aspect ratio is maintained, false otherwise.

ODRX_DECLARE_MEMBERS()

OdGiImageBackgroundTraits::ODRX_DECLARE_MEMBERS

(

OdGiImageBackgroundTraits

)

setFitToScreen()

virtual void OdGiImageBackgroundTraits::setFitToScreen ( bool  bFitToScreen )

pure virtual

Specifies whether image-based background should be fit to screen.

Parameters

bFitToScreen

[in] Flag that specifies whether to fit this background to screen.

setImageFilename()

virtual void OdGiImageBackgroundTraits::setImageFilename ( const OdString &  filename )

pure virtual

Specifies image file name.

Parameters

filename

[in] Full path to an image file.

setMaintainAspectRatio()

virtual void OdGiImageBackgroundTraits::setMaintainAspectRatio ( bool  bMaintainAspectRatio )

pure virtual

Specifies whether image-based background should maintain aspect ratio. Usually called together with setFitToScreen() methods or other methods which can modify background dimensions.

Parameters

bMaintainAspectRatio

[in] Flag that specifies whether to maintain aspect ratio of a background image.

setUseTiling()

virtual void OdGiImageBackgroundTraits::setUseTiling ( bool  bUseTiling )

pure virtual

Specifies whether to tile image-based background.

Parameters

bUseTiling

[in] Flag that specifies whether to tile image-based background.

Remarks

Note that background cannot be tiled if it is set to fit to screen.

setXOffset()

virtual void OdGiImageBackgroundTraits::setXOffset ( double  xOffset )

pure virtual

Specifies offset of a background on the x-axis.

Parameters

xOffset

[in] Offset distance. Negative values mean that background is offset in the opposite direction of x-axis.

setXScale()

virtual void OdGiImageBackgroundTraits::setXScale ( double  xScale )

pure virtual

Specifies scale of a background on the x-axis.

Parameters

xScale

[in] Scale factor for the x-axis.

setYOffset()

virtual void OdGiImageBackgroundTraits::setYOffset ( double  yOffset )

pure virtual

Specifies offset of a background on the y-axis.

Parameters

yOffset

[in] Offset distance. Negative values mean that background is offset in the opposite direction of y-axis.

setYScale()

virtual void OdGiImageBackgroundTraits::setYScale ( double  yScale )

pure virtual

Specifies scale of a background on the y-axis.

Parameters

yScale

[in] Scale factor for the y-axis.

useTiling()

virtual bool OdGiImageBackgroundTraits::useTiling ( ) const

pure virtual

Checks whether image-based background is tiled.

Returns

true if background is tiled, false otherwise.

xOffset()

virtual double OdGiImageBackgroundTraits::xOffset ( ) const

pure virtual

Retrieves offset of a background on the x-axis.

Returns

offset value on the x-axis.

xScale()

virtual double OdGiImageBackgroundTraits::xScale ( ) const

pure virtual

Retrieves scale of a background on the x-axis.

Returns

Scale of the x-axis for this background. Values between 0 and 1 mean that background is shrunk on x-axis, values greater than 1 mean than background is stretched and negative values mean that background is flipped on x-axis.

yOffset()

virtual double OdGiImageBackgroundTraits::yOffset ( ) const

pure virtual

Retrieves offset of a background on the y-axis.

Returns

offset value on the y-axis.

yScale()

virtual double OdGiImageBackgroundTraits::yScale ( ) const

pure virtual

Retrieves scale of a background on the y-axis.

Returns

Scale of the y-axis for this background. Values between 0 and 1 mean that background is shrunk on y-axis, values greater than 1 mean than background is stretched and negative values mean that background is flipped on y-axis.

---

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

• GiEnvironment.h