GraphCanvas::GridRequests Class Reference

#include <GridBus.h>

Inherits AZ::EBusTraits.

Public Types
using	BusIdType = AZ::EntityId

Public Member Functions
virtual void	SetMajorPitch (const AZ::Vector2 &)=0
virtual AZ::Vector2	GetMajorPitch () const =0
virtual void	SetMinorPitch (const AZ::Vector2 &)=0
virtual AZ::Vector2	GetMinorPitch () const =0
virtual void	SetMinimumVisualPitch (int)=0
virtual int	GetMinimumVisualPitch () const =0
	Get the smallest on-screen distance between grid lines that is allowable for them to still be rendered.

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById

Detailed Description

GridRequests Requests which are serviced by the GraphCanvas::Connection component.

Member Function Documentation

GetMajorPitch()

virtual AZ::Vector2 GraphCanvas::GridRequests::GetMajorPitch ( ) const

pure virtual

Get the major grid line pitch. Contains the distinct X and Y pitches.

GetMinorPitch()

virtual AZ::Vector2 GraphCanvas::GridRequests::GetMinorPitch ( ) const

pure virtual

Get the minor grid line pitch. Contains the distinct X and Y pitches.

SetMajorPitch()

virtual void GraphCanvas::GridRequests::SetMajorPitch ( const AZ::Vector2 &  )

pure virtual

Set the major grid line pitch. The pitch is specified in scene coordinates and X and Y can be separately specified.

SetMinimumVisualPitch()

virtual void GraphCanvas::GridRequests::SetMinimumVisualPitch ( int  )

pure virtual

When the view is zoomed, the grid lines (minor and/or major) could become too close together to be useful or visually appealing. If the on-screen (i.e. scaled) distance in pixels between grid lines falls below this threshold, they will no longer be drawn. This will cause the minor and then the major grid lines to disappear as we zoom out further and further.

SetMinorPitch()

virtual void GraphCanvas::GridRequests::SetMinorPitch ( const AZ::Vector2 &  )

pure virtual

Set the minor grid line pitch. The pitch is specified in scene coordinates and X and Y can be separately specified. NOTE: This pitch should be a factor of the major pitch.

---

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

• Gems/GraphCanvas/Code/StaticLib/GraphCanvas/Components/GridBus.h