GradientSignal::ImageGradientRequests Class Reference

Inherits AZ::ComponentBus.

Public Member Functions
virtual AZStd::string	GetImageAssetPath () const =0
virtual AZStd::string	GetImageAssetSourcePath () const =0
virtual void	SetImageAssetPath (const AZStd::string &assetPath)=0
virtual void	SetImageAssetSourcePath (const AZStd::string &assetPath)=0
virtual uint32_t	GetImageHeight () const =0
virtual uint32_t	GetImageWidth () const =0
virtual AZ::Vector2	GetImagePixelsPerMeter () const =0
virtual float	GetTilingX () const =0
virtual void	SetTilingX (float tilingX)=0
virtual float	GetTilingY () const =0
virtual void	SetTilingY (float tilingY)=0

Static Public Attributes
static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single

Member Function Documentation

GetImageAssetPath()

virtual AZStd::string GradientSignal::ImageGradientRequests::GetImageAssetPath ( ) const

pure virtual

Get the path to the processed image asset.

Returns

The image asset path

GetImageAssetSourcePath()

virtual AZStd::string GradientSignal::ImageGradientRequests::GetImageAssetSourcePath ( ) const

pure virtual

Get the path to the source image asset.

Returns

The source image asset path

GetImageHeight()

virtual uint32_t GradientSignal::ImageGradientRequests::GetImageHeight ( ) const

pure virtual

Get the image height

Returns

The image height in pixels

GetImagePixelsPerMeter()

virtual AZ::Vector2 GradientSignal::ImageGradientRequests::GetImagePixelsPerMeter ( ) const

pure virtual

Get the image pixels per meter Using the Image Gradient's mapping of an image to world space, this returns how many pixels per meter exist in each direction. This information is useful for image painting/modifications to know the correct spacing for modifying the image pixel-by-pixel.

Returns

The number of pixels per meter in the X and Y directions.

GetImageWidth()

virtual uint32_t GradientSignal::ImageGradientRequests::GetImageWidth ( ) const

pure virtual

Get the image width

Returns

The image width in pixels

GetTilingX()

virtual float GradientSignal::ImageGradientRequests::GetTilingX ( ) const

pure virtual

Gets the tiling setting for the X direction A value of 1 is a 1:1 mapping of the image to the gradient bounds.

Returns

Tiling factor for X

GetTilingY()

virtual float GradientSignal::ImageGradientRequests::GetTilingY ( ) const

pure virtual

Gets the tiling setting for the Y direction A value of 1 is a 1:1 mapping of the image to the gradient bounds.

Returns

Tiling factor for Y

SetImageAssetPath()

virtual void GradientSignal::ImageGradientRequests::SetImageAssetPath ( const AZStd::string &  assetPath )

pure virtual

Set the image asset for the component by providing a path to the processed image asset.

Parameters

assetPath

The path to the processed image asset

SetImageAssetSourcePath()

virtual void GradientSignal::ImageGradientRequests::SetImageAssetSourcePath ( const AZStd::string &  assetPath )

pure virtual

Set the image asset for the component by providing a path to the source image asset.

Parameters

assetPath

The path to the source image asset

SetTilingX()

virtual void GradientSignal::ImageGradientRequests::SetTilingX ( float  tilingX )

pure virtual

Sets the tiling setting for the X direction

Parameters

tilingX

Tiling factor for X

SetTilingY()

virtual void GradientSignal::ImageGradientRequests::SetTilingY ( float  tilingY )

pure virtual

Sets the tiling setting for the Y direction

Parameters

tilingY

Tiling factor for Y

Member Data Documentation

HandlerPolicy

const AZ::EBusHandlerPolicy GradientSignal::ImageGradientRequests::HandlerPolicy = AZ::EBusHandlerPolicy::Single

static

Overrides the default AZ::EBusTraits handler policy to allow one listener only.

---

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

• Gems/GradientSignal/Code/Include/GradientSignal/Ebuses/ImageGradientRequestBus.h