|
|
ezRmlUiCanvas3DComponent & | operator= (ezRmlUiCanvas3DComponent &&rhs) |
| |
| virtual void | OnActivated () override |
| | This method is called when the component gets activated.
|
| |
| virtual void | OnDeactivated () override |
| | This method is called when the component gets deactivated.
|
| |
| void | Update () final override |
| |
| bool | ReceiveInput (const ezVec2 &vMousePosInsideCanvas, ezRmlUiInputSnapshot input) override |
| |
|
bool | RaycastInput (const ezVec3 &vRayOrigin, const ezVec3 &vRayDir, ezRmlUiInputSnapshot input) |
| |
|
void | SetProxyMesh (const ezMeshResourceHandle &hMesh) |
| | Changes which mesh will be used for hit testing.
|
| |
|
const ezMeshResourceHandle & | GetProxyMesh () const |
| |
|
| EZ_ADD_RESOURCEHANDLE_ACCESSORS_WITH_SETTER (ProxyMesh, m_hProxyMesh, SetProxyMesh) |
| |
|
void | SetBaseMaterial (const ezMaterialResourceHandle &hMaterial) |
| |
|
const ezMaterialResourceHandle & | GetBaseMaterial () const |
| |
|
| EZ_ADD_RESOURCEHANDLE_ACCESSORS_WITH_SETTER (BaseMaterial, m_hBaseMaterial, SetBaseMaterial) |
| |
|
void | SetMaterialIndex (ezUInt32 uiMaterialIndex) |
| |
|
ezUInt32 | GetMaterialIndex () const |
| |
|
void | SetTextureSlotName (ezStringView sName) |
| |
|
ezStringView | GetTextureSlotName () const |
| |
|
void | SetTextureSize (const ezVec2U32 &vSize) |
| |
|
const ezVec2U32 & | GetTextureSize () const |
| |
|
void | SetDpiScale (float fDpiScale) |
| |
|
float | GetDpiScale () const |
| |
|
void | SetClearStaleInput (bool bClearStaleInput) |
| |
|
bool | GetClearStaleInput () const |
| |
|
void | SetInteractive (bool bIsInteractive) |
| |
|
bool | IsInteractive () const |
| |
| virtual void | SerializeComponent (ezWorldWriter &inout_stream) const override |
| | Override this to save the current state of the component to the given stream.
|
| |
| virtual void | DeserializeComponent (ezWorldReader &inout_stream) override |
| | Override this to load the current state of the component from the given stream.
|
| |
|
ezRmlUiCanvasComponentBase & | operator= (ezRmlUiCanvasComponentBase &&rhs) |
| |
| virtual void | Initialize () override |
| | Can be overridden for basic initialization that depends on a valid hierarchy and position.
|
| |
| virtual void | Deinitialize () override |
| | This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.
|
| |
|
| EZ_ADD_RESOURCEHANDLE_ACCESSORS_WITH_SETTER (RmlResource, m_hResource, SetRmlResource) |
| |
|
void | SetRmlResource (const ezRmlUiResourceHandle &hResource) |
| |
|
const ezRmlUiResourceHandle & | GetRmlResource () const |
| |
|
void | SetAutobindBlackboards (bool bAutobind) |
| | Look for a blackboard component on the owner object and its parent and bind their blackboards during initialization of this component.
|
| |
|
bool | GetAutobindBlackboards () const |
| |
|
void | SetSendEventMessage (bool bSendEventMessage) |
| | If enabled, the component will send an ezMsgRmlUiEventMessage for each RmlUI event that is triggered on the context.
|
| |
|
bool | GetSendEventMessage () const |
| |
|
void | SetOnDemandUpdate (bool bOnDemandUpdate) |
| |
|
bool | GetOnDemandUpdate () const |
| |
|
ezUInt32 | AddDataBinding (ezUniquePtr< ezRmlUiDataBinding > &&pDataBinding) |
| |
|
void | RemoveDataBinding (ezUInt32 uiDataBindingIndex) |
| |
|
ezUInt32 | AddBlackboardBinding (const ezSharedPtr< ezBlackboard > &pBlackboard) |
| | Adds the given blackboard as data binding. The name of the board is used as model name for the binding.
|
| |
|
void | RemoveBlackboardBinding (ezUInt32 uiDataBindingIndex) |
| |
|
ezRmlUiContext * | GetOrCreateRmlContext () |
| |
|
ezRmlUiContext * | GetRmlContext () |
| |
| virtual ezResult | GetLocalBounds (ezBoundingBoxSphere &ref_bounds, bool &ref_bAlwaysVisible, ezMsgUpdateLocalBounds &ref_msg) override |
| | Called by ezRenderComponent::OnUpdateLocalBounds().
|
| |
|
void | TriggerLocalBoundsUpdate () |
| | Call this when some value was modified that affects the size of the local bounding box and it should be recomputed.
|
| |
|
void | QueueLocalBoundsUpdate () |
| | Like TriggerLocalBoundsUpdate(), but defers the update and is safe to call from async update functions.
|
| |
|
EZ_ALWAYS_INLINE ezUInt32 | GetUniqueIdForRendering () const |
| | Computes a unique ID for the given component, that is usually given to the renderer to distinguish objects.
|
| |
| void | SetActiveFlag (bool bEnabled) |
| | Sets the active flag of the component, which affects its active state.
|
| |
| bool | GetActiveFlag () const |
| | Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'.
|
| |
| bool | IsActive () const |
| | Checks whether this component is in an active state.
|
| |
| bool | IsActiveAndInitialized () const |
| | Returns whether this component is active and initialized.
|
| |
| bool | IsActiveAndSimulating () const |
| | Whether the component is currently active and simulation has been started as well.
|
| |
|
ezComponentManagerBase * | GetOwningManager () |
| | Returns the corresponding manager for this component.
|
| |
|
const ezComponentManagerBase * | GetOwningManager () const |
| | Returns the corresponding manager for this component.
|
| |
|
ezGameObject * | GetOwner () |
| | Returns the owner game object if the component is attached to one or nullptr.
|
| |
|
const ezGameObject * | GetOwner () const |
| | Returns the owner game object if the component is attached to one or nullptr.
|
| |
|
ezWorld * | GetWorld () |
| | Returns the corresponding world for this component.
|
| |
|
const ezWorld * | GetWorld () const |
| | Returns the corresponding world for this component.
|
| |
|
ezComponentHandle | GetHandle () const |
| | Returns a handle to this component.
|
| |
|
ezUInt32 | GetUniqueID () const |
| | Returns the unique id for this component.
|
| |
|
void | SetUniqueID (ezUInt32 uiUniqueID) |
| | Sets the unique id for this component.
|
| |
|
void | EnsureInitialized () |
| | Ensures that the component is initialized. Must only be called from another component's Initialize callback.
|
| |
|
void | EnsureSimulationStarted () |
| | Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.
|
| |
|
EZ_ALWAYS_INLINE bool | SendMessage (ezMessage &ref_msg) |
| | Sends a message to this component.
|
| |
|
EZ_ALWAYS_INLINE bool | SendMessage (ezMessage &ref_msg) const |
| |
|
void | PostMessage (const ezMessage &msg, ezTime delay=ezTime::MakeZero(), ezObjectMsgQueueType::Enum queueType=ezObjectMsgQueueType::NextFrame) const |
| | Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.
|
| |
| virtual bool | HandlesMessage (const ezMessage &msg) const |
| | Returns whether the given Message is handled by this component.
|
| |
|
void | SetUserFlag (ezUInt8 uiFlagIndex, bool bSet) |
| | Be careful to check which flags may already be in use by base classes.
|
| |
|
bool | GetUserFlag (ezUInt8 uiFlagIndex) const |
| | Retrieves a custom flag. Index must be between 0 and 7.
|
| |
|
void | SetCreatedByPrefab () |
| | Adds ezObjectFlags::CreatedByPrefab to the component. See the flag for details.
|
| |
|
bool | WasCreatedByPrefab () const |
| | Checks whether the ezObjectFlags::CreatedByPrefab flag is set on this component.
|
| |
|
void | DeleteComponent () |
| | Deletes this component. Note that the component will be invalidated first and the actual deletion is postponed.
|
| |
|
virtual const ezRTTI * | GetDynamicRTTI () const |
| |
|
bool | IsInstanceOf (const ezRTTI *pType) const |
| | Returns whether the type of this instance is of the given type or derived from it.
|
| |
|
template<typename T > |
| EZ_ALWAYS_INLINE bool | IsInstanceOf () const |
| | Returns whether the type of this instance is of the given type or derived from it.
|
| |
|
| virtual void | OnMsgExtractRenderData (ezMsgExtractRenderData &msg) const override |
| |
| virtual void | OnMsgReload (ezMsgRmlUiReload &msg) override |
| |
|
bool | UpdateTextureAndMaterial () |
| |
|
void | UpdateCachedValues () |
| |
|
void | UpdateAutobinding () |
| |
|
void | UpdateEventHandler () |
| |
|
void | EventHandler (const ezHashedString &sIdentifier, Rml::Event &event) |
| |
|
void | OnUpdateLocalBounds (ezMsgUpdateLocalBounds &msg) |
| |
|
void | InvalidateCachedRenderData () |
| |
|
| ezComponent () |
| | Keep the constructor private or protected in derived classes, so it cannot be called manually.
|
| |
|
bool | IsDynamic () const |
| | Returns whether this component is dynamic and thus can only be attached to dynamic game objects.
|
| |
|
virtual ezWorldModuleTypeId | GetTypeId () const =0 |
| |
|
virtual ezComponentMode::Enum | GetMode () const =0 |
| |
| virtual void | OnSimulationStarted () |
| | This method is called once for active components, at the start of the next world update, but only when the world is simulated.
|
| |
|
void | EnableUnhandledMessageHandler (bool enable) |
| | By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.
|
| |
| virtual bool | OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg) |
| | When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.
|
| |
| virtual bool | OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg) const |
| | When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.
|
| |
|
bool | IsInitialized () const |
| |
|
bool | IsInitializing () const |
| |
|
bool | IsSimulationStarted () const |
| |
Public Member Functions inherited from ezRmlUiCanvasComponentBase
1.9.8