Open 3D Engine PhysX Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
PhysX::EditorJointRequests Class Referenceabstract

Messages serviced by Editor Joint Components. More...

#include <EditorJointBus.h>

Inherits AZ::EntityComponentBus.

Public Member Functions

virtual bool GetBoolValue (const AZStd::string &parameterName)=0
 
virtual AZ::EntityId GetEntityIdValue (const AZStd::string &parameterName)=0
 
virtual float GetLinearValue (const AZStd::string &parameterName)=0
 
virtual AngleLimitsFloatPair GetLinearValuePair (const AZStd::string &parameterName)=0
 
virtual AZ::Vector3 GetVector3Value (const AZStd::string &parameterName)=0
 
virtual AZ::Transform GetTransformValue (const AZStd::string &parameterName)=0
 
virtual AZStd::vector< JointsComponentModeCommon::SubModeParameterState > GetSubComponentModesState ()=0
 Get the Sub Component modes to enable.
 
virtual void SetBoolValue (const AZStd::string &parameterName, bool value)=0
 Set bool parameter value identified by name.
 
virtual void SetEntityIdValue (const AZStd::string &parameterName, AZ::EntityId value)=0
 Set entity ID parameter value identified by name.
 
virtual void SetLinearValue (const AZStd::string &parameterName, float value)=0
 Set linear parameter value identified by name.
 
virtual void SetLinearValuePair (const AZStd::string &parameterName, const AngleLimitsFloatPair &valuePair)=0
 Set linear parameter value pair identified by name.
 
virtual void SetVector3Value (const AZStd::string &parameterName, const AZ::Vector3 &value)=0
 Set vector3 parameter value identified by name.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

Messages serviced by Editor Joint Components.

Member Function Documentation

◆ GetBoolValue()

virtual bool PhysX::EditorJointRequests::GetBoolValue ( const AZStd::string &  parameterName)
pure virtual

Get bool parameter value identified by name.

Returns
Value of bool parameter.

◆ GetEntityIdValue()

virtual AZ::EntityId PhysX::EditorJointRequests::GetEntityIdValue ( const AZStd::string &  parameterName)
pure virtual

Get entityID parameter value identified by name.

Returns
Value of entityID parameter.

◆ GetLinearValue()

virtual float PhysX::EditorJointRequests::GetLinearValue ( const AZStd::string &  parameterName)
pure virtual

Get linear parameter value identified by name.

Returns
Value of linear value parameter.

◆ GetLinearValuePair()

virtual AngleLimitsFloatPair PhysX::EditorJointRequests::GetLinearValuePair ( const AZStd::string &  parameterName)
pure virtual

Get linear parameter value pair identified by name.

Returns
Linear parameter value pair.

◆ GetTransformValue()

virtual AZ::Transform PhysX::EditorJointRequests::GetTransformValue ( const AZStd::string &  parameterName)
pure virtual

Get transform value identified by name.

Returns
Transform parameter value.

◆ GetVector3Value()

virtual AZ::Vector3 PhysX::EditorJointRequests::GetVector3Value ( const AZStd::string &  parameterName)
pure virtual

Get vector3 value identified by name.

Returns
Vector3 parameter value.
The documentation for this class was generated from the following file: