A simple view which downloads and renders images.
Overview
SetImage may be provided with a locally-sourced or pre-downloaded image in the form of a CYIAssetTextureBase, or using a CYIUrl indicating a remote resource from which to download and display the image. If downloading the image success is indicated by the emission of ImageAssigned, and failure by ImageAssignmentFailed. When a valid image is available and ready for display it will be displayed according to the ScaleMode specified in SetScaleMode or via the "scale-mode" property in the view template. By default the scale mode is CYIImageView::ScaleMode::Fill, meaning that the image will retain its aspect ratio and resize such that it entirely fills the CYIImageView with the excess being cropped.
The initial state of the ImageNode will serve as a placeholder until the first image is applied to it, and again if Reset is called.
When using CYIImageView in a layout it will need to support being re-sized, this usually means that a layout must be applied on the CYIImageView as well in order to make sure that the ImageNode and its decorations are laid out gracefully in response to size changes. For instance, the ImageNode should be marked as a 'background' so that it re-sizes along with the image view enabling the CYIImageView's scaling options to take effect. Note that marking the ImageNode as a background limits the types of animations that can be applied to it, for more information refer to the Animation section.
- Note
- Image views implement their own scaling logic. As a result, using alignment options with a CYILayout is not supported in image views. The image will always be center-aligned in the CYIImageView.
Animation
CYIImageView can be in one of four visual states and has a series of (optional) timelines representing transitions between those states. These are illustrated below:
If the view has the "ImageSet" timeline, representing a transition out of the "Placeholder" state and into the "Image" state, then it will begin in the "Placeholder" state; otherwise it will begin in the "Image" state.
Placeholder and Placeholder Failure States
The "Placeholder" state is the initial state of the view if the view contains the "ImageSet" timeline.
The timelines: "ImageSet," "ImageSetFailure," and "ImageSetRecovery" represent the possible transitions in these states.
The "Placeholder" state represents the initial state of the view template, as it appears immediately after CYISceneView::BuildFromTemplate. If an image download fails while the view is in this state, it will transition to the "Placeholder Failure" state using the "ImageSetFailure" timeline. If no "ImageSetFailure" timeline is specified the error will not be represented visually but the ImageAssignmentFailed signal will still be emitted.
If an image is successfully set while the view is in the "Placeholder" state, it will transition to the "Image" state using the "ImageSet" timeline.
If the view is in the "Placeholder Failure" state when the image is set it will transition to the "Image" state using the "ImageSetRecovery" timeline if present, or the "ImageSetFailure" timeline in reverse if present, or finally the "ImageSet" timeline.
If the view is in the "Placeholder Failure" state, subsequent failures will not be visually represented but will still cause the emission of ImageAssignmentFailed.
Once an image has been set on the view successfully the only way to return to these states is via CYIImageView::Reset.
Image and Failure States
Once an image has been set on the view, or if there is no "ImageSet" timeline present, the view is be in the "Image" state.
The timelines: "ImageSwapFailure," "ImageSwapRecovery," and "ImageSwap" represent the possible transitions in these states.
The "Image" state represents the state of the view after CYISceneView::BuildFromTemplate and completion of the "ImageSet" timeline, if present. If an image download fails while the view is in this state, it will transition to the "Failure" state using the "ImageSwapFailure" timeline. If no "ImageSwapFailure" timeline is specified the error will not be represented visually but the ImageAssignmentFailed signal will still be emitted.
If an image is successfully set while the view is in the "Image" state, it will play the "ImageSwap" timeline and remain in the "Image" state. The "ImageSwap" timeline should animate the ImageNode as the incoming image, e.g. fading it in or sliding it into position. If a more complex image swapping animation is required, the optional node 'ImageNode-Outgoing' can be used to represent the image being replaced.
If the view is in the "Failure" state when the image is set it will transition to the "Image" state using the "ImageSwapRecovery" timeline if present, or the "ImageSwapFailure" timeline in reverse if present, or finally the "ImageSwap" timeline.
If the view is in the "Failure" state, subsequent failures will not be visually represented but will still cause the emission of ImageAssignmentFailed.
Important Animation Considerations
If using CYIImageView in a layout it's desirable to ensure proper sizing and placement of sub-components by applying a layout to the CYIImageView itself. Usually, 'ImageNode' is marked as a background in these cases, which prohibits the use of position and anchor point animations as they'll be overwritten immediately by layout.
If animating items into and out of the view's bounds it may be desirable to enable clipping on CYIImageView via CYISceneNode::SetClippingOn or the "clip" property of the view template.
View Template Specification
Type | Labels | Property | Description |
Node | ImageNode | Required | The node that will be used to render the image. When using the 'ImageSwap' timeline, represents the incoming image. See Animation for more details. |
Node | ImageNode-Outgoing | Optional | When using the 'ImageSwap' timeline, represents the outgoing image. See Animation for more details. |
Marker | ImageSet | Optional | Played when switching from the default image (as it appears in the view template, or after calling Reset()). See Animation for more details. |
Marker | ImageSetFailure | Optional | Played when switching from the default image (as it appears in the view template, or after calling Reset())image fails. See Animation for more details. |
Marker | ImageSetRecovery | Optional | Played when recovering from a placeholder to image transition failure. See Animation for more details. |
Marker | ImageSwap | Optional | Played when swapping between images, except when switching from the default image (as it appears in the view template, or after calling Reset()) image. See Animation for more details. |
Marker | ImageSwapFailure | Optional | Played when swapping between images fails. See Animation for more details. |
Marker | ImageSwapRecovery | Optional | Played when recovering from an image swapping failure. See Animation for more details. |
Comment | mipmapping | Optional | Values can be true or false. By default, the value is false. |
Comment | scale-mode | Optional | The scaling mode which will be applied to the image node. Valid values are stretch, fill, fill-with-overflow, fit, actual-size, and actual-size-with-overflow. Defaults to fit. - See also
- ScaleMode
|
Comment | repeat-mode | Optional | The repeat mode which will be applied when the image is smaller than the 'ImageNode' size. Valid values are none, tile, mirror, clamp. The default value is 'none'. - See also
- CYIImageView::RepeatMode
|
|
| CYIImageView () |
|
virtual | ~CYIImageView () |
|
virtual bool | Init () override |
|
void | SetScaleMode (ScaleMode scaleMode) |
|
ScaleMode | GetScaleMode () const |
|
void | SetRepeatMode (RepeatMode repeatMode) |
|
RepeatMode | GetRepeatMode () const |
|
void | SetMipmappingEnabled (bool enable) |
|
bool | IsMipmappingEnabled () const |
|
void | SetImage (const std::shared_ptr< CYIAssetTextureBase > &pTexture, bool isNPatch=false) |
|
void | SetImage (const CYIUrl &url) |
|
virtual void | Reset () override |
|
void | SetOverlayTextColor (const CYIColor &color) |
|
void | SetOverlayTextSize (const uint32_t &fontSize) |
|
void | SetOverlayTextFontID (const ssize_t &fontID) |
|
void | SetOverlayText (const CYIString &text) |
|
virtual void | OnImageHasChanged () |
|
CYISceneNode * | GetImageNode () const |
|
void | SetImageUrl (const CYIUrl &url) |
|
const CYIUrl & | GetImageUrl () const |
|
virtual void | Measure (const MeasureSpec &widthSpec, const MeasureSpec &heightSpec, const MeasureSpec &depthSpec) override |
|
virtual void | ApplyMeasurements () override |
|
| CYISceneView () |
|
virtual | ~CYISceneView () |
|
bool | BuildFromTemplate (CYISceneManager *pSceneManager, const std::shared_ptr< CYIAssetViewTemplate > &pAssetViewTemplate, CYISceneManager::MissingClassHandlingMode missingHandlingMode=CYISceneManager::MissingClassHandlingMode::Abort) |
|
bool | IsInitialized () const |
|
void | SetClippingAreaNode (CYISceneNode *pClippingNode) |
|
virtual CYIOptional< CYIStringView > | GetProperty (CYIStringView propertyName) const override |
|
bool | GetProperty (CYIStringView propertyName, CYIString *pValue) const |
|
virtual std::map< CYIString, CYIString > | GetProperties () const override |
|
virtual void | ForEachProperty (const std::function< void(const CYIString &, const CYIString &)> &action) const override |
|
virtual bool | HasProperties () const override |
|
void | EnableDefaultHitZone () |
|
bool | IsResponsiveLayoutEnabled () const |
|
void | EnableResponsiveLayout () |
|
void | DisableResponsiveLayout () |
|
void | AddAnchor (EYIAnchorType anchorType) |
|
YI_ANCHOR_DATA | GetAnchor (EYIAnchorType anchorType) const |
|
virtual const CYISceneView::AssetRequirement * | GetAssetRequirements (uint32_t *pRequirementCount) |
|
CYIAbstractTimeline * | GetInTimeline () const |
|
CYIAbstractTimeline * | GetOutTimeline () const |
|
CYIAbstractTimeline * | GetFocusInTimeline () const |
|
CYIAbstractTimeline * | GetFocusOutTimeline () const |
|
virtual bool | HandlesFocusInDescendants () const |
|
virtual bool | RequestFocus (CYIFocus::Direction direction=CYIFocus::Direction::Forward, CYIFocus::FocusRootRule focusRootRule=CYIFocus::FocusRootRule::DescendantsUpdateContext, const CYIAABB &previousFocusRect=CYIAABB(), const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) |
|
bool | HasFocus () const |
|
void | SetFocusable (bool focusable) |
|
bool | IsFocusable () const |
|
bool | CanBeFocused () const |
|
void | SetNextFocus (CYISceneView *pView, CYIFocus::Direction direction) |
|
CYISceneView * | GetNextFocus (CYIFocus::Direction direction) const |
|
virtual void | SetInitiallyFocusedView (CYISceneView *pView, InitialFocusLifetime initialFocusLifetime=InitialFocusLifetime::Persistent) |
|
CYISceneView * | GetInitiallyFocusedView () const |
|
CYISceneView::InitialFocusLifetime | GetInitialFocusLifetime () const |
|
CYISceneView * | FindNextFocus (CYIFocus::Direction direction, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const |
|
CYISceneView * | FindNextFocus (CYIFocus::Direction direction, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const |
|
virtual CYISceneView * | FindNextFocusInDescendants (const CYISceneView *pCurrentFocusView, CYIFocus::Direction direction, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const |
|
const CYISceneNode * | GetFocusRoot () const |
|
CYISceneView * | GetFocusHandler () const |
|
virtual void | OnFocusGained () |
|
virtual void | FocusGained () |
|
virtual void | OnFocusLost () |
|
virtual void | FocusLost () |
|
virtual void | FocusGainedInDescendants (CYISceneNode *pNewNodeWithFocus, CYISceneNode *pPreviousNodeWithFocus) override |
|
virtual bool | ContainsFocusableDescendant (const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const override |
|
const std::shared_ptr< CYIAssetViewTemplate > & | GetViewTemplate () const |
|
const std::vector< CYIString > & | GetChildTemplateNames () |
|
virtual CYIAbstractTimeline * | GetTimeline (CYIStringView markerName, TimelineGetMode mode=TimelineGetMode::GetDefault) |
|
CYIAbstractTimeline * | GetTimeline (CYIMarkerData::ID id, TimelineGetMode mode=TimelineGetMode::GetDefault) |
|
std::map< CYIString, CYITimeline * > | GetTimelines () const |
|
bool | FindTimeline (CYIAbstractTimeline *&pTimeline, CYIStringView markerName, FetchType type, const CYIString &tag="", TimelineGetMode mode=TimelineGetMode::GetDefault) |
|
CYITimelineGroup * | GetTimelineGroup (CYIStringView markerName) |
|
std::unique_ptr< CYITimelineGroup > | BuildTimelineGroup (CYIStringView markerName) |
|
void | BuildAnchorList () |
|
void | SetLayout (std::unique_ptr< CYILayout > pLayout) |
|
const CYILayout * | GetLayout () const |
|
CYILayout * | GetLayout () |
|
| CYISceneNode () |
|
virtual | ~CYISceneNode () |
|
bool | IsInitialized () const |
|
void | ForceDirty () |
|
void | SetDirtyFlag (DirtyFlag dirtyFlag) |
|
DirtyFlag | GetDirtyFlag () const |
|
DirtyFlag | GetPreviousDirtyFlag () const |
|
const CYIString & | GetName () const |
|
CYIString | GetUniqueName () const |
|
void | SetSceneManager (CYISceneManager *pSceneManager) |
|
void | SetName (const CYIString &name) |
|
int32_t | GetID () const |
|
void | SetID (int32_t id) |
|
uint64_t | GetUniqueID () const |
|
bool | AddChild (std::unique_ptr< CYISceneNode > pSceneNode) |
|
bool | AddChild (std::unique_ptr< CYISceneNode >, size_t index) |
|
bool | InsertChildAfter (CYISceneNode *pRefNode, std::unique_ptr< CYISceneNode > pSceneNode) |
|
std::unique_ptr< CYISceneNode > | RemoveChild (CYISceneNode *pSceneNode) |
|
bool | ReorderChild (size_t fromIndex, size_t toIndex) |
|
CYITransform * | GetTransform () |
|
CYISceneNode * | GetParent () const |
|
bool | ChangeParent (CYISceneNode *pParent) |
|
CYISceneNode * | GetDrawParent () const |
|
bool | IsAncestorOf (const CYISceneNode *pNode) const |
|
CYISceneManager * | GetSceneManager () const |
|
size_t | GetChildCount () const |
|
uint32_t | GetChildCountRecursive () const |
|
CYISceneNode * | GetChild (size_t index) const |
|
Iterator | begin (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const |
|
Iterator | end (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const |
|
ReverseIterator | rbegin (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const |
|
ReverseIterator | rend (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const |
|
CYISceneNode * | GetChild (const CYIString &name) const |
|
size_t | GetDrawChildCount () const |
|
CYISceneNode * | GetDrawChild (size_t index) const |
|
CYISceneNode * | GetDrawChildByID (int32_t id) const |
|
template<class YI_SCENE_NODE_SUBCLASS > |
YI_SCENE_NODE_SUBCLASS * | GetChild (uint32_t targetMatchedNodeCount=1) const |
|
template<class YI_SCENE_NODE_SUBCLASS > |
std::list< YI_SCENE_NODE_SUBCLASS * > | GetChildren () const |
|
template<class YI_SCENE_NODE_SUBCLASS > |
std::list< YI_SCENE_NODE_SUBCLASS * > | GetDrawChildren () const |
|
size_t | GetIndexOfChild (const CYISceneNode *pSceneNode) const |
|
size_t | GetIndexOfDrawChild (const CYISceneNode *pSceneNode) const |
|
void | Show () |
|
void | Hide () |
|
void | SetVisibility (bool visible) |
|
void | SetOpacity (float opacity) |
|
float | GetCompositeOpacity () const |
|
float | GetLocalOpacity () const |
|
bool | IsVisible () const |
|
bool | IsTrulyVisible () const |
|
bool | IsPerceptible () const |
|
CYISceneNode * | GetNode (CYIStringView name) |
|
CYISceneNode * | GetNode (CYIStringView name, const CYIRuntimeTypeInfo &enforceClassType) |
|
CYISceneNode * | GetNode (const CYIRuntimeTypeInfo &enforceClassType) |
|
CYISceneNode * | GetNodeAfterTarget (const CYIRuntimeTypeInfo &enforceClassType, CYISceneNode *pStartAfterTarget) |
|
template<class YI_SCENE_NODE_SUBCLASS > |
YI_SCENE_NODE_SUBCLASS * | GetNode (CYIStringView name) |
|
CYISceneNode * | GetNode (const int32_t id) |
|
CYISceneNode * | GetNode (const int32_t id, const CYIRuntimeTypeInfo &enforceClassType) |
|
CYISceneNode * | GetNodeWithUniqueID (uint64_t uniqueID) |
|
template<class YI_SCENE_NODE_SUBCLASS > |
bool | FindNode (YI_SCENE_NODE_SUBCLASS *&pNode, CYIStringView nodeName, FetchType type, const CYIString &tag) |
|
std::list< CYISceneNode * > | GetNodes (CYIStringView name) |
|
std::list< CYISceneNode * > | GetNodes (int32_t id) |
|
std::list< CYISceneNode * > | GetNodes (const CYIRuntimeTypeInfo &enforceClassType) |
|
template<class YI_SCENE_NODE_SUBCLASS > |
const YI_SCENE_NODE_SUBCLASS * | GetNode (uint32_t targetMatchedNodeCount=1) const |
|
template<class YI_SCENE_NODE_SUBCLASS > |
YI_SCENE_NODE_SUBCLASS * | GetNode (uint32_t targetMatchedNodeCount=1) |
|
void | SetMesh (const std::shared_ptr< CYIMesh > &pMesh) |
|
bool | SetNPatchBitmap (const std::shared_ptr< CYIBitmap > &pNPatchBitmap) |
|
void | ClearNPatch () |
|
void | SetMaterial (const std::shared_ptr< CYIMaterial > &pMaterial, size_t index=0) |
|
void | AddEffect (const std::shared_ptr< CYIEffect > &pEffect) |
|
void | RemoveEffect (const std::shared_ptr< CYIEffect > &pEffect) |
|
size_t | GetEffectCount () const |
|
const std::shared_ptr< CYIEffect > & | GetEffect (size_t index) const |
|
void | ConnectEffectsToTimelines (const CYITimelineTrack *pTrack) |
|
void | AddMask (std::unique_ptr< CYIMask > pMask) |
|
std::unique_ptr< CYIMask > | RemoveMask (const CYIMask *pMask) |
|
size_t | GetMaskCount () const |
|
const CYIMask * | GetMask (size_t index) const |
|
CYIMask * | GetMask (size_t index) |
|
const std::shared_ptr< CYIMesh > & | GetMesh () const |
|
const std::shared_ptr< CYIBitmap > & | GetNPatchBitmap () const |
|
size_t | GetMaterialCount () const |
|
const std::shared_ptr< CYIMaterial > & | GetMaterial (size_t index=0) const |
|
const std::shared_ptr< IYIUniformBufferObject > & | GetShaderUniforms () const |
|
void | SetMeshTransform (const glm::mat4 &rTransform) |
|
void | DestroyChildren () |
|
glm::mat4 | GetLocalTransform () const |
|
glm::mat4 | GetWorldTransform () const |
|
bool | Intersects (const CYISceneNode *pNode) const |
|
void | SetRenderTarget (const std::shared_ptr< CYIRenderTarget > &pRenderTarget) |
|
const std::shared_ptr< CYIRenderTarget > & | GetRenderTarget () const |
|
virtual void | OnPreBuildDrawList (std::vector< IYIRenderer::Command > *pDrawList, std::vector< CYIAbstractCameraSceneNode *> *pDrawWithCameraList) |
|
virtual void | OnPostBuildDrawList (std::vector< IYIRenderer::Command > *pDrawList) |
|
const CYIAABB & | GetWorldAABB () const |
|
const CYIAABB & | GetLocalAABB () const |
|
void | SetAnchorPoint (const glm::vec3 &anchorPoint) |
|
void | SetAnchorPoint (float x, float y, float z) |
|
void | SetAnchorPointX (float x) |
|
void | SetAnchorPointY (float y) |
|
void | SetAnchorPointZ (float z) |
|
void | SetPosition (const glm::vec3 &position) |
|
void | SetPosition (float x, float y, float z) |
|
void | SetPositionX (float x) |
|
void | SetPositionY (float y) |
|
void | SetPositionZ (float z) |
|
void | SetRotation (const glm::vec3 &rotation) |
|
void | SetRotation (float pitchDegrees, float yawDegrees, float rollDegrees) |
|
void | SetRotationX (float pitchDegrees) |
|
void | SetRotationY (float yawDegrees) |
|
void | SetRotationZ (float rollDegrees) |
|
void | SetOrientation (float pitchDegrees, float yawDegrees, float rollDegrees) |
|
void | SetOrientation (const glm::quat &orientation) |
|
void | SetScale (const glm::vec3 &scale) |
|
void | SetScale (float factorX, float factorY, float factorZ) |
|
void | SetScaleX (float factor) |
|
void | SetScaleY (float factor) |
|
void | SetScaleZ (float factor) |
|
const glm::vec3 & | GetPosition () const |
|
const glm::vec3 & | GetScale () const |
|
const glm::vec3 & | GetWorldScale () const |
|
const glm::vec3 & | GetWorldSurfaceScale () const |
|
const glm::vec3 & | GetRotation () const |
|
const glm::quat & | GetOrientation () const |
|
const glm::vec3 & | GetAnchorPoint () const |
|
virtual void | SetSize (const glm::vec3 &size, bool dirtyLayout=true) |
|
const glm::vec3 & | GetSize () const |
|
const glm::vec3 & | GetInitialSize () const |
|
void | SetMeasuredSize (const glm::vec3 &measuredSize) |
|
const glm::vec3 & | GetMeasuredSize () const |
|
void | SetInternalCustomTimelineValue (uint32_t trackID, const CYIVariant &value) |
|
virtual void | SetCustomTimelineValue (uint32_t trackID, const CYIVariant &value) |
|
void | SetClippingOn () |
|
void | SetClippingOff () |
|
bool | GetClipping () const |
|
void | SetClippingBox (const CYIAABB &rWorldBox) |
|
const CYIAABB & | GetClippingBox () const |
|
void | StartPropertyAnimation (PropertyAnimation::Type propType, float from, float to, uint32_t durMs, CYITimeInterpolator *pTimeInterpolator=nullptr, bool dirtyLayout=true) |
|
void | StopPropertyAnimation (PropertyAnimation::Type propType) |
|
void | UpdateLocalSpaceCollision (CYIActionEvent *pActionEvent) |
|
virtual bool | BroadcastEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) |
|
void | UpdateEventForLocalSpace (CYIActionEvent *pActionEvent, glm::vec3 &rayOrigin, glm::vec3 &rayNonOriginPoint) const |
|
bool | IsBoundingBoxHit (const CYIRay &rWorldSpaceRay) const |
|
bool | IsMeshHit (const CYIRay &rWorldSpaceRay) const |
|
void | DumpTree () const |
|
void | StartCaptureKeyboardEvents () |
|
void | StopCaptureKeyboardEvents () |
|
void | StartCaptureTrackpadEvents () |
|
void | StopCaptureTrackpadEvents () |
|
void | StartCapturePointerEvents (uint8_t pointerID) |
|
void | StopCapturePointerEvents (uint8_t pointerID) |
|
bool | DrawBehindChildren (CYISceneNode *pSceneNode, bool *pChanged=nullptr) |
|
bool | DrawInFrontOfChildren (CYISceneNode *pSceneNode, bool *pChanged=nullptr) |
|
bool | DrawBehind (CYISceneNode *pSceneNode, bool *pChanged=nullptr) |
|
bool | DrawInFront (CYISceneNode *pSceneNode, bool *pChanged=nullptr) |
|
bool | IsFocusRoot () const |
|
void | SetIsFocusRoot (bool isFocusRoot) |
|
virtual void | OnFocusGainedInDescendants (CYISceneNode *pNewNodeWithFocus, CYISceneNode *pPreviousNodeWithFocus) |
|
virtual void | OnFocusLostInDescendants (CYISceneNode *pNewNodeWithFocus, CYISceneNode *pPreviousNodeWithFocus) |
|
virtual void | FocusLostInDescendants (CYISceneNode *pNewNodeWithFocus, CYISceneNode *pPreviousNodeWithFocus) |
|
virtual void | OnFocusChangedInDescendants (CYISceneNode *pNewNodeWithFocus, CYISceneNode *pPreviousNodeWithFocus) |
|
virtual void | FocusChangedInDescendants (CYISceneNode *pNewNodeWithFocus, CYISceneNode *pPreviousNodeWithFocus) |
|
void | SetUseLocalTransformAndAlpha (bool use) |
|
bool | GetProperty (CYIStringView propertyName, CYIString *pValue) const |
|
void | SetProperty (const CYIString &rPropertyName, const CYIString &rPropertyValue) |
|
std::shared_ptr< CYISceneNodeProxy > | GetSceneNodeProxy () const |
|
void | SetLayoutConfig (std::unique_ptr< CYILayoutConfig > pLayoutConfig) |
|
const CYILayoutConfig * | GetLayoutConfig (LayoutConfigFetchMode fetchMode=LayoutConfigFetchMode::LazyInstantiate) const |
|
CYILayoutConfig * | GetLayoutConfig (LayoutConfigFetchMode fetchMode=LayoutConfigFetchMode::LazyInstantiate) |
|
void | SetLayoutState (std::unique_ptr< CYILayoutState > pLayoutState) |
|
const CYILayoutState * | GetLayoutState () const |
|
CYILayoutState * | GetLayoutState () |
|
void | RequestLayout () |
|
LayoutDirtyFlag | GetLayoutDirtyFlag () const |
|
virtual void | SetLayoutDirtyFlag (LayoutDirtyFlag flag) |
|
virtual CYIAbstractCameraSceneNode * | FindActiveCamera (const CYISceneNode *pTargetSceneNode=nullptr) const |
|
CYIAccessibilityAttributes::Accessible | GetAccessible () const |
|
void | SetAccessible (CYIAccessibilityAttributes::Accessible accessible) |
|
const CYIAccessibilityAttributes * | GetAccessibilityAttributes () const |
|
std::unique_ptr< CYIAccessibilityAttributes > | TakeAccessibilityAttributes () |
|
void | SetAccessibilityAttributes (std::unique_ptr< CYIAccessibilityAttributes > pAttributes) |
|
const CYIRenderable * | GetRenderable () const |
|
template<typename T > |
bool | CanCastTo () const |
|
CYIAdjustmentLayerSceneNode * | GetLastAdjustmentLayer () const |
|
| CYIEventTarget () |
|
virtual | ~CYIEventTarget () |
|
bool | AddEventListener (CYIEvent::Type eventType, CYIEventHandler *pListener, CYIEventTarget::Phase phase=CYIEventTarget::Phase::Bubble) |
|
bool | RemoveEventListener (CYIEvent::Type eventType, CYIEventHandler *pListener, CYIEventTarget::Phase phase=CYIEventTarget::Phase::Bubble) |
|
void | SetSpecialTypeFlag (SpecialEventTargetType type) |
|
void | ClearSpecialTypeFlag (SpecialEventTargetType type) |
|
SpecialEventTargetType | GetSpecialTypes () const |
|
const std::shared_ptr< CYIEventTargetProxy > & | GetProxy () const |
|
Public Member Functions inherited from CYISignalHandler |
| CYISignalHandler () |
|
| CYISignalHandler (const CYISignalHandler &rSignalHandler) |
|
virtual | ~CYISignalHandler () |
|
CYISignalHandler & | operator= (const CYISignalHandler &rSignalHandler) |
|
void | MoveToThread (CYIThread *pThread) |
| This function allows the user to override the default thread affinity to any CYIThread that may or may not be running. More...
|
|
CYIThreadHandle | GetThreadAffinity () const |
|
void | SetThreadAffinity (const CYIThreadHandle &rThreadAffinity) |
|
virtual bool | IsConnected () const |
|
virtual bool | IsConnected (const CYISignalBase &rSignal) const |
|
void | Disconnect (CYISignalBase &rSignal) |
|
void | DisconnectFromAllSignals () |
|
| Listener () |
|
virtual | ~Listener () |
|
virtual void | OnThreadStarted (CYIThread *) |
|
virtual void | OnThreadTerminated (CYIThread *) |
|
virtual void | OnThreadFinished (CYIThread *) |
|
virtual | ~IYIPropertiesSource ()=default |
|
bool | GetProperty (CYIStringView propertyName, CYIString *pValue) const |
|
Public Member Functions inherited from CYIEventHandler |
| CYIEventHandler () |
|
| CYIEventHandler (const CYIEventHandler &) |
|
virtual | ~CYIEventHandler () |
|
CYIEventHandler & | operator= (const CYIEventHandler &) |
|
bool | RegisterEventFilter (CYIEventFilter *pFilter) |
|
bool | UnregisterEventFilter (CYIEventFilter *pFilter) |
|
bool | PreFilter (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) |
|
bool | PostFilter (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) |
|
bool | AreEventsEnabled () const |
|
void | EnableEvents (bool enable) |
|