LmbrCentral::TubeShapeComponentRequests Class Reference

Services provided by the TubeShapeComponent. More...

#include <TubeShapeComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions
virtual void	SetRadius (float radius)=0
	Sets the radius for the Tube.
virtual float	GetRadius () const =0
	Gets the radius of the Tube.
virtual void	SetVariableRadius (int index, float radius)=0
	Sets the variable radius along the tube.
virtual void	SetAllVariableRadii (float radius)=0
	Sets the variable radius of all vertices along the tube.
virtual float	GetVariableRadius (int index) const =0
	Gets the variable radius of the tube for a given spline point.
virtual float	GetTotalRadius (const AZ::SplineAddress &address) const =0
	Gets the final interpolated radius of the tube for a given spline address.
virtual const SplineAttribute< float > &	GetRadiusAttribute () const =0
	Gets the radius spline attribute.

Detailed Description

Services provided by the TubeShapeComponent.

Member Function Documentation

GetRadius()

virtual float LmbrCentral::TubeShapeComponentRequests::GetRadius ( ) const

pure virtual

Gets the radius of the Tube.

Returns

the radius of the Tube.

GetTotalRadius()

virtual float LmbrCentral::TubeShapeComponentRequests::GetTotalRadius ( const AZ::SplineAddress &  address ) const

pure virtual

Gets the final interpolated radius of the tube for a given spline address.

Parameters

address

The address along the spline.

GetVariableRadius()

virtual float LmbrCentral::TubeShapeComponentRequests::GetVariableRadius ( int  index ) const

pure virtual

Gets the variable radius of the tube for a given spline point.

Parameters

index

An index of a point into the attached spline.

SetAllVariableRadii()

virtual void LmbrCentral::TubeShapeComponentRequests::SetAllVariableRadii ( float  radius )

pure virtual

Sets the variable radius of all vertices along the tube.

Parameters

radius

The variable radius to set for the spline point.

SetRadius()

virtual void LmbrCentral::TubeShapeComponentRequests::SetRadius ( float  radius )

pure virtual

Sets the radius for the Tube.

Parameters

radius

of the Tube.

SetVariableRadius()

virtual void LmbrCentral::TubeShapeComponentRequests::SetVariableRadius ( int  index, float  radius  )

pure virtual

Sets the variable radius along the tube.

Parameters

index	The index of a spline point.
radius	The variable radius to set for the spline point.

---

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

• Gems/LmbrCentral/Code/include/LmbrCentral/Shape/TubeShapeComponentBus.h