Dali 3D User Interface Engine
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes
Dali::Internal::CameraActor Class Reference

An actor with a conveniently pre-attached CameraAttachment. More...

#include <camera-actor-impl.h>

Inheritance diagram for Dali::Internal::CameraActor:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::CameraActor:
Collaboration graph
[legend]

Public Member Functions

void OnInitialize ()
  More...
 
CameraAttachmentGetCameraAttachment ()
 Retrieve the camera attachment. More...
 
void SetType (Dali::Camera::Type type)
 Set the camera type. More...
 
Dali::Camera::Type GetType () const
 Get the type of the camera. More...
 
void SetProjectionMode (Dali::Camera::ProjectionMode mode)
 Set the projection mode. More...
 
Dali::Camera::ProjectionMode GetProjectionMode () const
 Get the projection mode. More...
 
void SetFieldOfView (float fieldOfView)
 Set the field of view. More...
 
float GetFieldOfView () const
 Get the field of view in Radians. More...
 
void SetAspectRatio (float aspectRatio)
 Set the aspect ratio. More...
 
float GetAspectRatio () const
 Get the aspect ratio of the camera. More...
 
void SetNearClippingPlane (float nearClippingPlane)
 Sets the near clipping plane distance. More...
 
float GetNearClippingPlane () const
 Get the near clipping plane distance. More...
 
void SetFarClippingPlane (float farClippingPlane)
 Sets the far clipping plane distance. More...
 
float GetFarClippingPlane () const
 Get the far clipping plane distance. More...
 
void SetTargetPosition (const Vector3 &targetPosition)
 Set the target position of the camera. More...
 
Vector3 GetTargetPosition () const
 Get Camera Target position. More...
 
void SetInvertYAxis (bool invertYAxis)
 Request for an inversion on the Y axis on the projection calculation. More...
 
bool GetInvertYAxis () const
  More...
 
void SetPerspectiveProjection (const Size &size, const Vector2 &stereoBias=Vector2::ZERO)
 Sets the default camera perspective projection for the given canvas size. More...
 
void SetOrthographicProjection (const Vector2 &size)
 Sets the camera projection to use orthographic projection. More...
 
void SetOrthographicProjection (float left, float right, float top, float bottom, float near, float far)
 Sets the camera projection to use orthographic projection with the given clip planes. More...
 
bool BuildPickingRay (const Vector2 &screenCoordinates, const Viewport &viewport, Vector4 &rayOrigin, Vector4 &rayDirection)
 Build a picking ray with this camera and given screen coordinates. More...
 
const MatrixGetViewMatrix () const
 Retrieve the view-matrix; This will only be valid when the actor is on-stage. More...
 
const MatrixGetProjectionMatrix () const
 Retrieve the projection-matrix; This will only be valid when the actor is on-stage. More...
 
virtual unsigned int GetDefaultPropertyCount () const
 copydoc Dali::Internal::Object More...
 
virtual void GetDefaultPropertyIndices (Property::IndexContainer &indices) const
 Retrieve all the indices that are associated with the default properties supported by the derived class. More...
 
virtual bool IsDefaultPropertyAnimatable (Property::Index index) const
 copydoc Dali::Internal::Object More...
 
virtual bool IsDefaultPropertyAConstraintInput (Property::Index index) const
 Query whether a default property can be used as an input to a constraint. More...
 
virtual Property::Type GetDefaultPropertyType (Property::Index index) const
 copydoc Dali::Internal::Object More...
 
virtual const char * GetDefaultPropertyName (Property::Index index) const
 copydoc Dali::Internal::Object More...
 
virtual Property::Index GetDefaultPropertyIndex (const std::string &name) const
 Query the index of a default property. More...
 
virtual void SetDefaultProperty (Property::Index index, const Property::Value &propertyValue)
 copydoc Dali::Internal::Object More...
 
virtual Property::Value GetDefaultProperty (Property::Index index) const
 copydoc Dali::Internal::Object More...
 
virtual bool IsDefaultPropertyWritable (Property::Index index) const
 copydoc Dali::Internal::Object More...
 
virtual const
SceneGraph::PropertyBase
GetSceneObjectAnimatableProperty (Property::Index index) const
 Retrieve an animatable property owned by the scene-graph object. More...
 
virtual const PropertyInputImplGetSceneObjectInputProperty (Property::Index index) const
 Retrieve a constraint input-property owned by the scene-graph object. More...
 
- Public Member Functions inherited from Dali::Internal::Actor
const std::string & GetName () const
 Retrieve the name of the actor. More...
 
void SetName (const std::string &name)
 Set the name of the actor. More...
 
unsigned int GetId () const
 Retrieve the unique ID of the actor. More...
 
void Attach (ActorAttachment &attachment)
 Attach an object to an actor. More...
 
ActorAttachmentPtr GetAttachment ()
 Retreive the object attached to an actor. More...
 
bool IsRoot () const
 Query whether an actor is the root actor, which is owned by the Stage. More...
 
bool OnStage () const
 Query whether the actor is connected to the Stage. More...
 
bool IsRenderable () const
 Query whether the actor has any renderers. More...
 
bool IsLayer () const
 Query whether the actor is of class Dali::Layer. More...
 
Dali::Layer GetLayer ()
 Gets the layer in which the actor is present. More...
 
void Add (Actor &child)
 Adds a child Actor to this Actor. More...
 
void Remove (Actor &child)
 Removes a child Actor from this Actor. More...
 
void Unparent ()
 Removes an actor from its parent. More...
 
unsigned int GetChildCount () const
 Retrieve the number of children held by the actor. More...
 
ActorPtr GetChildAt (unsigned int index) const
 Retrieve and child actor by index. More...
 
ActorContainerGetChildrenInternal ()
 Retrieve a reference to Actor's children. More...
 
ActorPtr FindChildByName (const std::string &actorName)
 Search through this actor's hierarchy for an actor with the given name. More...
 
ActorPtr FindChildById (const unsigned int id)
 Search through this actor's hierarchy for an actor with the given unique ID. More...
 
ActorGetParent () const
 Retrieve the parent of an Actor. More...
 
void SetSize (float width, float height)
 Sets the size of an actor. More...
 
void SetSize (float width, float height, float depth)
 Sets the size of an actor. More...
 
void SetSize (const Vector2 &size)
 Sets the size of an actor. More...
 
void SetSizeInternal (const Vector2 &size)
 Sets the update size for an actor. More...
 
void SetSize (const Vector3 &size)
 Sets the size of an actor. More...
 
void SetSizeInternal (const Vector3 &size)
 Sets the update size for an actor. More...
 
void SetWidth (float width)
 Set the width component of the Actor's size. More...
 
void SetHeight (float height)
 Set the height component of the Actor's size. More...
 
void SetDepth (float depth)
 Set the depth component of the Actor's size. More...
 
const Vector3GetTargetSize () const
 Retrieve the Actor's size from event side. More...
 
const Vector3GetCurrentSize () const
 Retrieve the Actor's size from update side. More...
 
virtual Vector3 GetNaturalSize () const
 Return the natural size of the actor. More...
 
void SetParentOrigin (const Vector3 &origin)
 Set the origin of an actor, within its parent's area. More...
 
void SetParentOriginX (float x)
 Set the x component of the parent-origin. More...
 
void SetParentOriginY (float y)
 Set the y component of the parent-origin. More...
 
void SetParentOriginZ (float z)
 Set the z component of the parent-origin. More...
 
const Vector3GetCurrentParentOrigin () const
 Retrieve the parent-origin of an actor. More...
 
void SetAnchorPoint (const Vector3 &anchorPoint)
 Set the anchor-point of an actor. More...
 
void SetAnchorPointX (float x)
 Set the x component of the anchor-point. More...
 
void SetAnchorPointY (float y)
 Set the y component of the anchor-point. More...
 
void SetAnchorPointZ (float z)
 Set the z component of the anchor-point. More...
 
const Vector3GetCurrentAnchorPoint () const
 Retrieve the anchor-point of an actor. More...
 
void SetPosition (float x, float y)
 Sets the position of the Actor. More...
 
void SetPosition (float x, float y, float z)
 Sets the position of the Actor. More...
 
void SetPosition (const Vector3 &position)
 Sets the position of the Actor. More...
 
void SetX (float x)
 Set the position of an actor along the X-axis. More...
 
void SetY (float y)
 Set the position of an actor along the Y-axis. More...
 
void SetZ (float z)
 Set the position of an actor along the Z-axis. More...
 
void TranslateBy (const Vector3 &distance)
 Translate an actor relative to its existing position. More...
 
const Vector3GetCurrentPosition () const
 Retrieve the position of the Actor. More...
 
const Vector3GetTargetPosition () const
 Retrieve the target position of the Actor. More...
 
const Vector3GetCurrentWorldPosition () const
 Retrieve the world-position of the Actor. More...
 
void SetPositionInheritanceMode (PositionInheritanceMode mode)
 Set the actors position inheritance mode. More...
 
PositionInheritanceMode GetPositionInheritanceMode () const
 Returns the actors position inheritance mode. More...
 
void SetOrientation (const Radian &angleRadians, const Vector3 &axis)
 Sets the orientation of the Actor. More...
 
void SetOrientation (const Quaternion &orientation)
 Sets the orientation of the Actor. More...
 
void RotateBy (const Radian &angleRadians, const Vector3 &axis)
 Rotate an actor around its existing rotation axis. More...
 
void RotateBy (const Quaternion &relativeRotation)
 Apply a relative rotation to an actor. More...
 
const QuaternionGetCurrentOrientation () const
 Retreive the Actor's orientation. More...
 
void SetInheritOrientation (bool inherit)
 Set whether a child actor inherits it's parent's orientation. More...
 
bool IsOrientationInherited () const
 Returns whether the actor inherit's it's parent's orientation. More...
 
void SetSizeModeFactor (const Vector3 &factor)
 Sets the factor of the parents size used for the child actor. More...
 
const Vector3GetSizeModeFactor () const
 Gets the factor of the parents size used for the child actor. More...
 
const QuaternionGetCurrentWorldOrientation () const
 Retrieve the world-orientation of the Actor. More...
 
void SetScale (float scale)
 Sets a scale factor applied to an actor. More...
 
void SetScale (float scaleX, float scaleY, float scaleZ)
 Sets a scale factor applied to an actor. More...
 
void SetScale (const Vector3 &scale)
 Sets a scale factor applied to an actor. More...
 
void SetScaleX (float x)
 Set the x component of the scale factor. More...
 
void SetScaleY (float y)
 Set the y component of the scale factor. More...
 
void SetScaleZ (float z)
 Set the z component of the scale factor. More...
 
void ScaleBy (const Vector3 &relativeScale)
 Apply a relative scale to an actor. More...
 
const Vector3GetCurrentScale () const
 Retrieve the scale factor applied to an actor. More...
 
const Vector3GetCurrentWorldScale () const
 Retrieve the world-scale of the Actor. More...
 
void SetInheritScale (bool inherit)
 Set whether a child actor inherits it's parent's scale. More...
 
bool IsScaleInherited () const
 Returns whether the actor inherits its parent's scale. More...
 
Matrix GetCurrentWorldMatrix () const
 Retrieves the world-matrix of the actor. More...
 
void SetVisible (bool visible)
 Sets the visibility flag of an actor. More...
 
bool IsVisible () const
 Retrieve the visibility flag of an actor. More...
 
void SetOpacity (float opacity)
 Sets the opacity of an actor. More...
 
float GetCurrentOpacity () const
 Retrieve the actor's opacity. More...
 
void SetSensitive (bool sensitive)
 Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover(). More...
 
bool IsSensitive () const
 Query whether an actor emits touch or hover event signals. More...
 
void SetDrawMode (DrawMode::Type drawMode)
 Set how the actor and its children should be drawn. More...
 
DrawMode::Type GetDrawMode () const
 Query how the actor and its children will be drawn. More...
 
void SetOverlay (bool enable)
  More...
 
bool IsOverlay () const
  More...
 
void SetColor (const Vector4 &color)
 Sets the actor's color. More...
 
void SetColorRed (float red)
 Set the red component of the color. More...
 
void SetColorGreen (float green)
 Set the green component of the color. More...
 
void SetColorBlue (float blue)
 Set the blue component of the scale factor. More...
 
const Vector4GetCurrentColor () const
 Retrieve the actor's color. More...
 
void SetColorMode (ColorMode colorMode)
 Sets the actor's color mode. More...
 
ColorMode GetColorMode () const
 Returns the actor's color mode. More...
 
const Vector4GetCurrentWorldColor () const
 Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range. More...
 
int GetHierarchyDepth () const
 Get depth in the hierarchy for the actor. More...
 
virtual void OnRelayout (const Vector2 &size, RelayoutContainer &container)
 Called after the size negotiation has been finished for this control. More...
 
virtual void OnSetResizePolicy (ResizePolicy::Type policy, Dimension::Type dimension)
 Notification for deriving classes when the resize policy is set. More...
 
virtual void OnCalculateRelayoutSize (Dimension::Type dimension)
 Virtual method to notify deriving classes that relayout dependencies have been met and the size for this object is about to be calculated for the given dimension. More...
 
virtual void OnLayoutNegotiated (float size, Dimension::Type dimension)
 Virtual method to notify deriving classes that the size for a dimension has just been negotiated. More...
 
virtual bool RelayoutDependentOnChildren (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's children for relayout. More...
 
virtual bool RelayoutDependentOnChildrenBase (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's children for relayout. More...
 
virtual float CalculateChildSize (const Dali::Actor &child, Dimension::Type dimension)
 Calculate the size for a child. More...
 
virtual float GetHeightForWidth (float width)
 This method is called during size negotiation when a height is required for a given width. More...
 
virtual float GetWidthForHeight (float height)
 This method is called during size negotiation when a width is required for a given height. More...
 
void NegotiateSize (const Vector2 &size, RelayoutContainer &container)
 Called by the RelayoutController to negotiate the size of an actor. More...
 
void SetResizePolicy (ResizePolicy::Type policy, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the resize policy to be used for the given dimension(s). More...
 
ResizePolicy::Type GetResizePolicy (Dimension::Type dimension) const
 Return the resize policy used for a single dimension. More...
 
void SetSizeScalePolicy (SizeScalePolicy::Type policy)
 Set the policy to use when setting size with size negotiation. More...
 
SizeScalePolicy::Type GetSizeScalePolicy () const
 Return the size scale policy in use. More...
 
void SetDimensionDependency (Dimension::Type dimension, Dimension::Type dependency)
  More...
 
Dimension::Type GetDimensionDependency (Dimension::Type dimension) const
  More...
 
void SetRelayoutEnabled (bool relayoutEnabled)
 Set the size negotiation relayout enabled on this actor. More...
 
bool IsRelayoutEnabled () const
 Return if relayout is enabled. More...
 
void SetLayoutDirty (bool dirty, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Mark an actor as having it's layout dirty. More...
 
bool IsLayoutDirty (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Return if any of an actor's dimensions are marked as dirty. More...
 
bool RelayoutPossible (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Returns if relayout is enabled and the actor is not dirty. More...
 
bool RelayoutRequired (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Returns if relayout is enabled and the actor is dirty. More...
 
void RelayoutRequest (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene) More...
 
bool RelayoutDependentOnParent (Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Determine if this actor is dependent on it's parent for relayout. More...
 
bool RelayoutDependentOnDimension (Dimension::Type dimension, Dimension::Type dependentDimension)
 Determine if this actor has another dimension depedent on the specified one. More...
 
void NegotiateDimensions (const Vector2 &allocatedSize)
 Negotiate sizes for a control in all dimensions. More...
 
void NegotiateDimension (Dimension::Type dimension, const Vector2 &allocatedSize, ActorDimensionStack &recursionStack)
 Negotiate size for a specific dimension. More...
 
float CalculateSize (Dimension::Type dimension, const Vector2 &maximumSize)
 Calculate the size of a dimension. More...
 
float ClampDimension (float size, Dimension::Type dimension)
 Clamp a dimension given the relayout constraints on this actor. More...
 
float NegotiateFromParent (Dimension::Type dimension)
 Negotiate a dimension based on the size of the parent. More...
 
float NegotiateFromParentFit (Dimension::Type dimension)
 Negotiate a dimension based on the size of the parent. More...
 
float NegotiateFromParentFlood (Dimension::Type dimension)
 Negotiate a dimension based on the size of the parent. More...
 
float NegotiateFromChildren (Dimension::Type dimension)
 Negotiate a dimension based on the size of the children. More...
 
void SetNegotiatedDimension (float negotiatedDimension, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the negotiated dimension value for the given dimension(s) More...
 
float GetNegotiatedDimension (Dimension::Type dimension) const
 Return the value of negotiated dimension for the given dimension. More...
 
void SetPadding (const Vector2 &padding, Dimension::Type dimension)
 Set the padding for a dimension. More...
 
Vector2 GetPadding (Dimension::Type dimension) const
 Return the value of padding for the given dimension. More...
 
float GetSize (Dimension::Type dimension) const
 Return the actor size for a given dimension. More...
 
float GetNaturalSize (Dimension::Type dimension) const
 Return the natural size of the actor for a given dimension. More...
 
float GetRelayoutSize (Dimension::Type dimension) const
 Return the amount of size allocated for relayout. More...
 
float GetLatestSize (Dimension::Type dimension) const
 If the size has been negotiated return that else return normal size. More...
 
void SetNegotiatedSize (RelayoutContainer &container)
 Apply the negotiated size to the actor. More...
 
void SetLayoutNegotiated (bool negotiated, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Flag the actor as having it's layout dimension negotiated. More...
 
bool IsLayoutNegotiated (Dimension::Type dimension=Dimension::ALL_DIMENSIONS) const
 Test whether the layout dimension for this actor has been negotiated or not. More...
 
float GetHeightForWidthBase (float width)
 provides the Actor implementation of GetHeightForWidth More...
 
float GetWidthForHeightBase (float height)
 provides the Actor implementation of GetWidthForHeight More...
 
float CalculateChildSizeBase (const Dali::Actor &child, Dimension::Type dimension)
 Calculate the size for a child. More...
 
void SetPreferredSize (const Vector2 &size)
 Set the preferred size for size negotiation. More...
 
Vector2 GetPreferredSize () const
 Return the preferred size used for size negotiation. More...
 
void SetMinimumSize (float size, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the minimum size an actor can be assigned in size negotiation. More...
 
float GetMinimumSize (Dimension::Type dimension) const
 Return the minimum relayout size. More...
 
void SetMaximumSize (float size, Dimension::Type dimension=Dimension::ALL_DIMENSIONS)
 Set the maximum size an actor can be assigned in size negotiation. More...
 
float GetMaximumSize (Dimension::Type dimension) const
 Return the maximum relayout size. More...
 
unsigned int AddRenderer (Renderer &renderer)
 Add a renderer to this actor. More...
 
unsigned int GetRendererCount () const
 Get the number of renderers on this actor. More...
 
RendererPtr GetRendererAt (unsigned int index)
 Get a Renderer by index. More...
 
void RemoveRenderer (Renderer &renderer)
 Remove an renderer from the actor. More...
 
void RemoveRenderer (unsigned int index)
 Remove an renderer from the actor. More...
 
bool ScreenToLocal (float &localX, float &localY, float screenX, float screenY) const
 Converts screen coordinates into the actor's coordinate system. More...
 
bool ScreenToLocal (const RenderTask &renderTask, float &localX, float &localY, float screenX, float screenY) const
 Converts screen coordinates into the actor's coordinate system. More...
 
bool ScreenToLocal (const Matrix &viewMatrix, const Matrix &projectionMatrix, const Viewport &viewport, float &localX, float &localY, float screenX, float screenY) const
 Converts from the actor's coordinate system to screen coordinates. More...
 
bool RaySphereTest (const Vector4 &rayOrigin, const Vector4 &rayDir) const
 Performs a ray-sphere test with the given pick-ray and the actor's bounding sphere. More...
 
bool RayActorTest (const Vector4 &rayOrigin, const Vector4 &rayDir, Vector4 &hitPointLocal, float &distance) const
 Performs a ray-actor test with the given pick-ray and the actor's geometry. More...
 
void SetLeaveRequired (bool required)
 Sets whether the actor should receive a notification when touch or hover motion events leave the boundary of the actor. More...
 
bool GetLeaveRequired () const
 This returns whether the actor requires touch or hover events whenever touch or hover motion events leave the boundary of the actor. More...
 
void SetKeyboardFocusable (bool focusable)
 Sets whether the actor should be focusable by keyboard navigation. More...
 
bool IsKeyboardFocusable () const
 Returns whether the actor is focusable by keyboard navigation. More...
 
bool GetTouchRequired () const
 Query whether the application or derived actor type requires touch events. More...
 
bool GetHoverRequired () const
 Query whether the application or derived actor type requires hover events. More...
 
bool GetWheelEventRequired () const
 Query whether the application or derived actor type requires wheel events. More...
 
bool IsHittable () const
 Query whether the actor is actually hittable. More...
 
ActorGestureDataGetGestureData ()
 Retrieve the gesture data associated with this actor. More...
 
bool IsGestureRequred (Gesture::Type type) const
 Queries whether the actor requires the gesture type. More...
 
bool EmitTouchEventSignal (const TouchEvent &event)
 Used by the EventProcessor to emit touch event signals. More...
 
bool EmitHoverEventSignal (const HoverEvent &event)
 Used by the EventProcessor to emit hover event signals. More...
 
bool EmitWheelEventSignal (const WheelEvent &event)
 Used by the EventProcessor to emit wheel event signals. More...
 
Dali::Actor::TouchSignalTypeTouchedSignal ()
 This signal is emitted when touch input is received. More...
 
Dali::Actor::HoverSignalTypeHoveredSignal ()
 This signal is emitted when hover input is received. More...
 
Dali::Actor::WheelEventSignalTypeWheelEventSignal ()
 This signal is emitted when wheel event is received. More...
 
Dali::Actor::OnStageSignalTypeOnStageSignal ()
 This signal is emitted after the actor has been connected to the stage. More...
 
Dali::Actor::OffStageSignalTypeOffStageSignal ()
 This signal is emitted after the actor has been disconnected from the stage. More...
 
Dali::Actor::OnRelayoutSignalTypeOnRelayoutSignal ()
 This signal is emitted after the size has been set on the actor during relayout. More...
 
void NotifySizeAnimation (Animation &animation, const Vector3 &targetSize)
 This should only be called by Animation, when the actors SIZE property is animated. More...
 
void NotifySizeAnimation (Animation &animation, float targetSize, Property::Index property)
 This should only be called by Animation, when the actors SIZE_WIDTH or SIZE_HEIGHT or SIZE_DEPTH property is animated. More...
 
virtual void OnSizeAnimation (Animation &animation, const Vector3 &targetSize)
 For use in derived classes. More...
 
void NotifyPositionAnimation (Animation &animation, const Vector3 &targetPosition)
 This should only be called by Animation, when the actors POSITION property is animated. More...
 
void NotifyPositionAnimation (Animation &animation, float targetPosition, Property::Index property)
 This should only be called by Animation, when the actors POSITION_X or POSITION_Y or POSITION_Z property is animated. More...
 
virtual void SetSceneGraphProperty (Property::Index index, const PropertyMetadata &entry, const Property::Value &value)
 Set the value of scene graph property. More...
 
virtual const
SceneGraph::PropertyOwner
GetPropertyOwner () const
  More...
 
virtual const
SceneGraph::PropertyOwner
GetSceneObject () const
 Retrieve the scene-graph object added by this object. More...
 
virtual int GetPropertyComponentIndex (Property::Index index) const
 Query whether the property is a component of a scene-graph property. More...
 
- Public Member Functions inherited from Dali::Internal::Object
 Object ()
 Constructor. More...
 
virtual void AddObserver (Observer &observer)
 Add an observer to the object. More...
 
virtual void RemoveObserver (Observer &observer)
 Remove an observer from the object. More...
 
virtual bool Supports (Capability capability) const
 Query whether an handle supports a given capability. More...
 
virtual unsigned int GetPropertyCount () const
 Query how many properties are provided by an handle. More...
 
virtual std::string GetPropertyName (Property::Index index) const
 Query the name of a property. More...
 
virtual Property::Index GetPropertyIndex (const std::string &name) const
 Query the index of a property. More...
 
virtual bool IsPropertyWritable (Property::Index index) const
 Query whether a property can be set using SetProperty(). More...
 
virtual bool IsPropertyAnimatable (Property::Index index) const
 Query whether a writable property can be the target of an animation or constraint. More...
 
virtual bool IsPropertyAConstraintInput (Property::Index index) const
 Query whether a property can be used as in input to a constraint. More...
 
virtual Property::Type GetPropertyType (Property::Index index) const
 Query the type of a property. More...
 
virtual void SetProperty (Property::Index index, const Property::Value &propertyValue)
 Set the value of an existing property. More...
 
virtual Property::Value GetProperty (Property::Index index) const
 Retrieve a property value. More...
 
virtual void GetPropertyIndices (Property::IndexContainer &indices) const
 Retrieve all the property indices for this object (including custom properties). More...
 
virtual Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue)
 Register a new animatable property. More...
 
virtual Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue, Property::AccessMode accessMode)
  More...
 
virtual Dali::PropertyNotification AddPropertyNotification (Property::Index index, int componentIndex, const Dali::PropertyCondition &condition)
 Add a property notification to this object. More...
 
virtual void RemovePropertyNotification (Dali::PropertyNotification propertyNotification)
 Remove a property notification from this object. More...
 
virtual void RemovePropertyNotifications ()
 Remove all property notifications from this object. More...
 
void AddUniformMapping (Property::Index propertyIndex, const std::string &uniformName) const
  More...
 
void RemoveUniformMapping (const std::string &uniformName)
  More...
 
void ApplyConstraint (ConstraintBase &constraint)
 Apply a constraint to an Object. More...
 
void RemoveConstraint (ConstraintBase &constraint)
 Remove one constraint from an Object. More...
 
void RemoveConstraints ()
 Remove all constraints from a Object. More...
 
void RemoveConstraints (unsigned int tag)
 Remove all constraints from a Object with a matching tag. More...
 
void SetTypeInfo (const TypeInfo *typeInfo)
 Called by TypeInfo to set the type-info that this object-impl is created by. More...
 
unsigned int CustomPropertyStartIndex ()
 
- Public Member Functions inherited from Dali::BaseObject
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
bool DoConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, FunctorDelegate *functorDelegate)
 Not intended for application developers. More...
 
- Public Member Functions inherited from Dali::RefObject
void Reference ()
 Increment the object's reference count. More...
 
void Unreference ()
 Decrement the object's reference count. More...
 
int ReferenceCount ()
 Retrieve the object's reference count. More...
 

Static Public Member Functions

static CameraActorPtr New (const Size &size)
 Create an initialised camera actor. More...
 
- Static Public Member Functions inherited from Dali::Internal::Actor
static ActorPtr New ()
 Create a new actor. More...
 
static bool DoConnectSignal (BaseObject *object, ConnectionTrackerInterface *tracker, const std::string &signalName, FunctorDelegate *functor)
 Connects a callback function with the object's signals. More...
 
static bool DoAction (BaseObject *object, const std::string &actionName, const Property::Map &attributes)
 Performs actions as requested using the action name. More...
 

Protected Member Functions

 CameraActor ()
 Protected constructor; see also CameraActor::New() More...
 
virtual ~CameraActor ()
 A reference counted object may only be deleted by calling Unreference() More...
 
- Protected Member Functions inherited from Dali::Internal::Actor
 Actor (DerivedType derivedType)
 Protected Constructor. More...
 
void Initialize (void)
 Second-phase constructor. More...
 
virtual ~Actor ()
 A reference counted object may only be deleted by calling Unreference() More...
 
void ConnectToStage (unsigned int parentDepth)
 Called on a child during Add() when the parent actor is connected to the Stage. More...
 
void RecursiveConnectToStage (ActorContainer &connectionList, unsigned int depth)
 Helper for ConnectToStage, to recursively connect a tree of actors. More...
 
void ConnectToSceneGraph ()
 Connect the Node associated with this Actor to the scene-graph. More...
 
void NotifyStageConnection ()
 Helper for ConnectToStage, to notify a connected actor through the public API. More...
 
void DisconnectFromStage ()
 Called on a child during Remove() when the actor was previously on the Stage. More...
 
void RecursiveDisconnectFromStage (ActorContainer &disconnectionList)
 Helper for DisconnectFromStage, to recursively disconnect a tree of actors. More...
 
void DisconnectFromSceneGraph ()
 Disconnect the Node associated with this Actor from the scene-graph. More...
 
void NotifyStageDisconnection ()
 Helper for DisconnectFromStage, to notify a disconnected actor through the public API. More...
 
bool IsNodeConnected () const
 When the Actor is OnStage, checks whether the corresponding Node is connected to the scene graph. More...
 
- Protected Member Functions inherited from Dali::Internal::Object
virtual ~Object ()
 A reference counted object may only be deleted by calling Unreference() More...
 
void OnSceneObjectAdd ()
 Called immediately by derived classes, after the scene-object has been created & passed to the scene-graph. More...
 
void OnSceneObjectRemove ()
 Called by derived classes, shortly before send a message to remove the scene-object. More...
 
virtual void OnPropertySet (Property::Index index, Property::Value propertyValue)
 For use in derived classes. More...
 
const TypeInfoGetTypeInfo () const
 Retrieves the TypeInfo for this object. More...
 
CustomPropertyMetadataFindCustomProperty (Property::Index index) const
 Helper to find custom property. More...
 
AnimatablePropertyMetadataFindAnimatableProperty (Property::Index index) const
 Helper to find animatable property. More...
 
Property::Index RegisterSceneGraphProperty (const std::string &name, Property::Index index, const Property::Value &propertyValue) const
 Helper to register a scene-graph property. More...
 
AnimatablePropertyMetadataRegisterAnimatableProperty (Property::Index index) const
 Check whether the animatable property is registered already, if not then register one. More...
 
EventThreadServicesGetEventThreadServices ()
 Get the event thread services object - used for sending messages to the scene graph Assert if called from the wrong thread. More...
 
const EventThreadServicesGetEventThreadServices () const
 Get the event thread services object - used for sending messages to the scene graph Assert if called from the wrong thread This is intentionally inline for performance reasons. More...
 
- Protected Member Functions inherited from Dali::BaseObject
 BaseObject ()
 Default constructor. More...
 
virtual ~BaseObject ()
 A reference counted object may only be deleted by calling Unreference(). More...
 
void RegisterObject ()
 Registers the object as created with the Object registry. More...
 
void UnregisterObject ()
 Unregisters the object from Object registry. More...
 
- Protected Member Functions inherited from Dali::RefObject
 RefObject ()
 Default constructor. More...
 
virtual ~RefObject ()
 RefObject is intended as a base class. More...
 
 RefObject (const RefObject &rhs)
 Copy constructor. More...
 
RefObjectoperator= (const RefObject &rhs)
 Assignment operator. More...
 

Private Attributes

CameraAttachmentPtr mCameraAttachment
 

Additional Inherited Members

- Public Types inherited from Dali::Internal::Actor
typedef std::vector
< ActorDimensionPair
ActorDimensionStack
 
- Protected Types inherited from Dali::Internal::Actor
enum  DerivedType { BASIC, LAYER, ROOT_LAYER }
 
- Protected Attributes inherited from Dali::Internal::Actor
ActormParent
 Each actor (except the root) can have one parent. More...
 
ActorContainermChildren
 Container of referenced actors. More...
 
RendererContainermRenderers
 Renderer container. More...
 
const SceneGraph::NodemNode
 Not owned. More...
 
Vector3mParentOrigin
 NULL means ParentOrigin::DEFAULT. ParentOrigin is non-animatable. More...
 
Vector3mAnchorPoint
 NULL means AnchorPoint::DEFAULT. AnchorPoint is non-animatable. More...
 
RelayoutDatamRelayoutData
 Struct to hold optional collection of relayout variables. More...
 
ActorGestureDatamGestureData
 Optional Gesture data. Only created when actor requires gestures. More...
 
ActorAttachmentPtr mAttachment
 Optional referenced attachment. More...
 
Dali::Actor::TouchSignalType mTouchedSignal
 
Dali::Actor::HoverSignalType mHoveredSignal
 
Dali::Actor::WheelEventSignalType mWheelEventSignal
 
Dali::Actor::OnStageSignalType mOnStageSignal
 
Dali::Actor::OffStageSignalType mOffStageSignal
 
Dali::Actor::OnRelayoutSignalType mOnRelayoutSignal
 
Vector3 mTargetSize
 Event-side storage for size (not a pointer as most actors will have a size) More...
 
Vector3 mTargetPosition
 Event-side storage for position (not a pointer as most actors will have a position) More...
 
std::string mName
 Name of the actor. More...
 
unsigned int mId
 A unique ID to identify the actor starting from 1, and 0 is reserved. More...
 
unsigned short mDepth:12
 Cached: The depth in the hierarchy of the actor. Only 4096 levels of depth are supported. More...
 
const bool mIsRoot: 1
 Flag to identify the root actor. More...
 
const bool mIsLayer: 1
 Flag to identify that this is a layer. More...
 
bool mIsOnStage: 1
 Flag to identify whether the actor is on-stage. More...
 
bool mSensitive: 1
 Whether the actor emits touch event signals. More...
 
bool mLeaveRequired: 1
 Whether a touch event signal is emitted when the a touch leaves the actor's bounds. More...
 
bool mKeyboardFocusable: 1
 Whether the actor should be focusable by keyboard navigation. More...
 
bool mDerivedRequiresTouch: 1
 Whether the derived actor type requires touch event signals. More...
 
bool mDerivedRequiresHover: 1
 Whether the derived actor type requires hover event signals. More...
 
bool mDerivedRequiresWheelEvent: 1
 Whether the derived actor type requires wheel event signals. More...
 
bool mOnStageSignalled: 1
 Set to true before OnStageConnection signal is emitted, and false before OnStageDisconnection. More...
 
bool mInsideOnSizeSet: 1
 Whether we are inside OnSizeSet. More...
 
bool mInheritOrientation: 1
 Cached: Whether the parent's orientation should be inherited. More...
 
bool mInheritScale: 1
 Cached: Whether the parent's scale should be inherited. More...
 
DrawMode::Type mDrawMode: 2
 Cached: How the actor and its children should be drawn. More...
 
PositionInheritanceMode mPositionInheritanceMode: 2
 Cached: Determines how position is inherited. More...
 
ColorMode mColorMode: 2
 Cached: Determines whether mWorldColor is inherited. More...
 

Detailed Description

An actor with a conveniently pre-attached CameraAttachment.

Definition at line 37 of file camera-actor-impl.h.

Constructor & Destructor Documentation

Dali::Internal::CameraActor::CameraActor ( )
protected

Protected constructor; see also CameraActor::New()

Definition at line 167 of file camera-actor-impl.cpp.

Referenced by New().

Here is the caller graph for this function:

Dali::Internal::CameraActor::~CameraActor ( )
protectedvirtual

A reference counted object may only be deleted by calling Unreference()

Definition at line 172 of file camera-actor-impl.cpp.

Member Function Documentation

bool Dali::Internal::CameraActor::BuildPickingRay ( const Vector2 screenCoordinates,
const Viewport viewport,
Vector4 rayOrigin,
Vector4 rayDirection 
)

Build a picking ray with this camera and given screen coordinates.

Parameters
[in]screenCoordinatesthe ray passed through
[in]viewportto use
[out]rayOriginfor the picking ray
[out]rayDirectionfor the picking ray
Returns
true if the building was successful, false if its not possible (camera is not valid for hit testing)

Definition at line 330 of file camera-actor-impl.cpp.

References Dali::Internal::anonymous_namespace{camera-actor-impl.cpp}::BuildOrthoPickingRay(), Dali::Internal::Object::GetEventThreadServices(), GetNearClippingPlane(), GetProjectionMatrix(), GetProjectionMode(), GetViewMatrix(), Dali::Internal::SceneGraph::Node::GetWorldPosition(), Dali::Rect< T >::height, mCameraAttachment, Dali::Internal::Actor::mNode, Dali::Vector4::Normalize(), Dali::Camera::PERSPECTIVE_PROJECTION, Dali::Internal::Unproject(), Dali::Vector4::w, Dali::Rect< T >::width, Dali::Rect< T >::x, Dali::Vector2::x, Dali::Vector4::x, Dali::Rect< T >::y, Dali::Vector2::y, Dali::Vector4::y, and Dali::Vector4::z.

Referenced by Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::HitTestRenderTask().

Here is the call graph for this function:

Here is the caller graph for this function:

float Dali::Internal::CameraActor::GetAspectRatio ( ) const

Get the aspect ratio of the camera.

The default aspect ratio is 4.0f/3.0f. .0

Returns
The aspect ratio

Definition at line 211 of file camera-actor-impl.cpp.

References mCameraAttachment.

CameraAttachment& Dali::Internal::CameraActor::GetCameraAttachment ( )
inline

Retrieve the camera attachment.

Returns
The attachment.

Definition at line 61 of file camera-actor-impl.h.

References mCameraAttachment.

Property::Value Dali::Internal::CameraActor::GetDefaultProperty ( Property::Index  index) const
virtual
unsigned int Dali::Internal::CameraActor::GetDefaultPropertyCount ( ) const
virtual

copydoc Dali::Internal::Object

Reimplemented from Dali::Internal::Actor.

Definition at line 397 of file camera-actor-impl.cpp.

References Dali::Internal::Actor::GetDefaultPropertyCount().

Here is the call graph for this function:

Property::Index Dali::Internal::CameraActor::GetDefaultPropertyIndex ( const std::string &  name) const
virtual

Query the index of a default property.

Parameters
[in]nameThe name of the property.
Returns
The index of the property, or Property::INVALID_INDEX if no default property exists with the given name.

Reimplemented from Dali::Internal::Actor.

Definition at line 485 of file camera-actor-impl.cpp.

References Dali::DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, Dali::Internal::Actor::GetDefaultPropertyIndex(), and Dali::Property::INVALID_INDEX.

Here is the call graph for this function:

void Dali::Internal::CameraActor::GetDefaultPropertyIndices ( Property::IndexContainer indices) const
virtual

Retrieve all the indices that are associated with the default properties supported by the derived class.

Returns
A container of default property indices.
Note
The deriving class must not modify the existing elements in the container.

Reimplemented from Dali::Internal::Actor.

Definition at line 402 of file camera-actor-impl.cpp.

References Dali::DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, Dali::Internal::Actor::GetDefaultPropertyIndices(), Dali::Vector< T, IsTrivialType >::PushBack(), Dali::Vector< T, IsTrivialType >::Reserve(), and Dali::VectorBase::Size().

Here is the call graph for this function:

const char * Dali::Internal::CameraActor::GetDefaultPropertyName ( Property::Index  index) const
virtual
Property::Type Dali::Internal::CameraActor::GetDefaultPropertyType ( Property::Index  index) const
virtual
float Dali::Internal::CameraActor::GetFarClippingPlane ( ) const

Get the far clipping plane distance.

The default value is the default near clipping plane + (0xFFFF>>4). .0

Returns
The far clipping plane value

Definition at line 231 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::GetCameraClippingPlane().

Here is the caller graph for this function:

float Dali::Internal::CameraActor::GetFieldOfView ( ) const

Get the field of view in Radians.

The default field of view is 45 degrees. .0

Returns
The field of view in radians

Definition at line 201 of file camera-actor-impl.cpp.

References mCameraAttachment.

bool Dali::Internal::CameraActor::GetInvertYAxis ( ) const

Definition at line 251 of file camera-actor-impl.cpp.

References mCameraAttachment.

float Dali::Internal::CameraActor::GetNearClippingPlane ( ) const

Get the near clipping plane distance.

The default near clipping plane is 800.0f, to match the default screen height. Reduce this value to see objects closer to the camera. .0

Returns
The near clipping plane value

Definition at line 221 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by BuildPickingRay(), and Dali::Internal::HitTestAlgorithm::anonymous_namespace{hit-test-algorithm-impl.cpp}::GetCameraClippingPlane().

Here is the caller graph for this function:

const Matrix & Dali::Internal::CameraActor::GetProjectionMatrix ( ) const

Retrieve the projection-matrix; This will only be valid when the actor is on-stage.

Returns
The projection-matrix.

Definition at line 385 of file camera-actor-impl.cpp.

References Dali::Matrix::IDENTITY, mCameraAttachment, and Dali::Internal::Actor::OnStage().

Referenced by BuildPickingRay(), Dali::Internal::Actor::ScreenToLocal(), Dali::Internal::RenderTask::TranslateCoordinates(), and Dali::Internal::RenderTask::WorldToViewport().

Here is the call graph for this function:

Here is the caller graph for this function:

Dali::Camera::ProjectionMode Dali::Internal::CameraActor::GetProjectionMode ( ) const

Get the projection mode.

.0

Returns
One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION

Definition at line 191 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by BuildPickingRay().

Here is the caller graph for this function:

const SceneGraph::PropertyBase * Dali::Internal::CameraActor::GetSceneObjectAnimatableProperty ( Property::Index  index) const
virtual

Retrieve an animatable property owned by the scene-graph object.

Precondition
-1 < index < GetPropertyCount().
Parameters
[in]indexThe index of the property.
Returns
A dereferenceable pointer to a property, or NULL if a scene-object does not exist with this property.

Reimplemented from Dali::Internal::Actor.

Definition at line 740 of file camera-actor-impl.cpp.

References DALI_ASSERT_ALWAYS, Dali::DEFAULT_ACTOR_PROPERTY_MAX_COUNT, Dali::Internal::Actor::GetSceneObjectAnimatableProperty(), Dali::Internal::Object::IsPropertyAnimatable(), and Dali::Internal::Actor::OnStage().

Here is the call graph for this function:

const PropertyInputImpl * Dali::Internal::CameraActor::GetSceneObjectInputProperty ( Property::Index  index) const
virtual

Retrieve a constraint input-property owned by the scene-graph object.

Precondition
-1 < index < GetPropertyCount().
Parameters
[in]indexThe index of the property.
Returns
A dereferenceable pointer to an input property, or NULL if a scene-object does not exist with this property.

Reimplemented from Dali::Internal::Actor.

Definition at line 761 of file camera-actor-impl.cpp.

References DALI_LOG_WARNING, Dali::DEFAULT_ACTOR_PROPERTY_MAX_COUNT, Dali::DEFAULT_PROPERTY_MAX_COUNT, Dali::Internal::Actor::GetSceneObjectInputProperty(), mCameraAttachment, Dali::Internal::Actor::OnStage(), Dali::CameraActor::Property::PROJECTION_MATRIX, and Dali::CameraActor::Property::VIEW_MATRIX.

Here is the call graph for this function:

Vector3 Dali::Internal::CameraActor::GetTargetPosition ( ) const

Get Camera Target position.

The default target position is Vector3::ZERO. .0

Returns
The target position of the camera
Precondition
Camera type is LOOK_AT_TARGET.

Definition at line 241 of file camera-actor-impl.cpp.

References mCameraAttachment.

Dali::Camera::Type Dali::Internal::CameraActor::GetType ( ) const

Get the type of the camera.

.0

Returns
The type of camera

Definition at line 181 of file camera-actor-impl.cpp.

References mCameraAttachment.

const Matrix & Dali::Internal::CameraActor::GetViewMatrix ( ) const

Retrieve the view-matrix; This will only be valid when the actor is on-stage.

Returns
The view-matrix.

Definition at line 373 of file camera-actor-impl.cpp.

References Dali::Matrix::IDENTITY, mCameraAttachment, and Dali::Internal::Actor::OnStage().

Referenced by BuildPickingRay(), Dali::Internal::Actor::ScreenToLocal(), Dali::Internal::RenderTask::TranslateCoordinates(), and Dali::Internal::RenderTask::WorldToViewport().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Internal::CameraActor::IsDefaultPropertyAConstraintInput ( Property::Index  index) const
virtual

Query whether a default property can be used as an input to a constraint.

Parameters
[in]indexThe index of the property.
Returns
True if the property can be used as an input to a constraint.

Reimplemented from Dali::Internal::Actor.

Definition at line 435 of file camera-actor-impl.cpp.

References Dali::DEFAULT_ACTOR_PROPERTY_MAX_COUNT, Dali::DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, and Dali::Internal::Actor::IsDefaultPropertyAConstraintInput().

Here is the call graph for this function:

bool Dali::Internal::CameraActor::IsDefaultPropertyAnimatable ( Property::Index  index) const
virtual
bool Dali::Internal::CameraActor::IsDefaultPropertyWritable ( Property::Index  index) const
virtual
CameraActorPtr Dali::Internal::CameraActor::New ( const Size size)
static

Create an initialised camera actor.

Sets the default camera perspective projection for the given canvas size.

See Also
SetPerspectiveProjection().
Parameters
[in]sizeThe canvas size.
Returns
A smart-pointer to a newly allocated camera actor.

Definition at line 139 of file camera-actor-impl.cpp.

References Dali::ANGLE_180, CameraActor(), Dali::Internal::CameraAttachment::New(), Dali::Actor::SetName(), Dali::Actor::SetOrientation(), Dali::CameraActor::SetPerspectiveProjection(), and Dali::Vector3::YAXIS.

Here is the call graph for this function:

void Dali::Internal::CameraActor::OnInitialize ( )
virtual

Reimplemented from Dali::Internal::Actor.

Definition at line 163 of file camera-actor-impl.cpp.

void Dali::Internal::CameraActor::SetAspectRatio ( float  aspectRatio)

Set the aspect ratio.

.0

Parameters
[in]aspectRatioThe aspect ratio

Definition at line 206 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by SetPerspectiveProjection().

Here is the caller graph for this function:

void Dali::Internal::CameraActor::SetDefaultProperty ( Property::Index  index,
const Property::Value propertyValue 
)
virtual
void Dali::Internal::CameraActor::SetFarClippingPlane ( float  farClippingPlane)

Sets the far clipping plane distance.

.0

Parameters
[in]farClippingPlaneDistance of the far clipping plane

Definition at line 226 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by SetOrthographicProjection(), and SetPerspectiveProjection().

Here is the caller graph for this function:

void Dali::Internal::CameraActor::SetFieldOfView ( float  fieldOfView)

Set the field of view.

.0

Parameters
[in]fieldOfViewThe field of view in radians

Definition at line 196 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by SetPerspectiveProjection().

Here is the caller graph for this function:

void Dali::Internal::CameraActor::SetInvertYAxis ( bool  invertYAxis)

Request for an inversion on the Y axis on the projection calculation.

The default value is not inverted. .0

Parameters
[in]invertYAxisTrue if the Y axis should be inverted

Definition at line 246 of file camera-actor-impl.cpp.

References mCameraAttachment.

void Dali::Internal::CameraActor::SetNearClippingPlane ( float  nearClippingPlane)

Sets the near clipping plane distance.

.0

Parameters
[in]nearClippingPlaneDistance of the near clipping plane

Definition at line 216 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by SetOrthographicProjection(), and SetPerspectiveProjection().

Here is the caller graph for this function:

void Dali::Internal::CameraActor::SetOrthographicProjection ( const Vector2 size)

Sets the camera projection to use orthographic projection.

The XY plane is centered on the camera axis. The units in the X/Y plane directly equate to pixels on an equivalently sized framebuffer.

The Z position of the actor, and the near and far clip planes of the bounding box match those that would be created by using SetPerspectiveProjection with the same size.

.0

Parameters
[in]sizeSize of XY plane (normal to camera axis)

Definition at line 307 of file camera-actor-impl.cpp.

References Dali::Internal::anonymous_namespace{camera-actor-impl.cpp}::CalculateClippingAndZ(), Dali::Vector2::height, Dali::Internal::Actor::SetZ(), Dali::Vector2::width, Dali::Vector2::x, and Dali::Vector2::y.

Here is the call graph for this function:

void Dali::Internal::CameraActor::SetOrthographicProjection ( float  left,
float  right,
float  top,
float  bottom,
float  near,
float  far 
)

Sets the camera projection to use orthographic projection with the given clip planes.

This does not change the Z value of the camera actor.

.0

Parameters
[in]leftDistance to left clip plane (normal to camera axis)
[in]rightDistance to right clip plane (normal to camera axis)
[in]topDistance to top clip plane (normal to camera axis)
[in]bottomDistance to bottom clip plane (normal to camera axis)
[in]nearDistance to the near clip plane (along camera axis)
[in]farDistance to the far clip plane (along camera axis)

Definition at line 319 of file camera-actor-impl.cpp.

References mCameraAttachment, Dali::Camera::ORTHOGRAPHIC_PROJECTION, SetFarClippingPlane(), SetNearClippingPlane(), and SetProjectionMode().

Here is the call graph for this function:

void Dali::Internal::CameraActor::SetPerspectiveProjection ( const Size size,
const Vector2 stereoBias = Vector2::ZERO 
)

Sets the default camera perspective projection for the given canvas size.

Sets the near and far clipping planes, the field of view, the aspect ratio and the Z position of the actor based on the canvas size so that 1 unit in XY (z=0) plane is 1 pixel on screen.

If the canvas size is ZERO, it sets the default camera perspective projection for the stage's size.

.0

Parameters
[in]sizeThe canvas size.
Precondition
If size is non ZERO, width and height must be greater than zero.

Definition at line 256 of file camera-actor-impl.cpp.

References Dali::Internal::anonymous_namespace{camera-actor-impl.cpp}::CalculateClippingAndZ(), Dali::Internal::Stage::GetCurrent(), Dali::Internal::Stage::GetSize(), height, Dali::Vector2::height, Dali::Math::MACHINE_EPSILON_1000, mCameraAttachment, Dali::Camera::PERSPECTIVE_PROJECTION, SetAspectRatio(), SetFarClippingPlane(), SetFieldOfView(), SetNearClippingPlane(), SetProjectionMode(), Dali::Internal::Actor::SetZ(), width, Dali::Vector2::width, and Dali::Vector2::ZERO.

Here is the call graph for this function:

void Dali::Internal::CameraActor::SetProjectionMode ( Dali::Camera::ProjectionMode  mode)

Set the projection mode.

.0

Parameters
[in]modeOne of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION

Definition at line 186 of file camera-actor-impl.cpp.

References mCameraAttachment.

Referenced by SetOrthographicProjection(), and SetPerspectiveProjection().

Here is the caller graph for this function:

void Dali::Internal::CameraActor::SetTargetPosition ( const Vector3 targetPosition)

Set the target position of the camera.

.0

Parameters
[in]targetPositionThe position of the target to look at
Precondition
Camera type is LOOK_AT_TARGET.

Definition at line 236 of file camera-actor-impl.cpp.

References mCameraAttachment.

void Dali::Internal::CameraActor::SetType ( Dali::Camera::Type  type)

Set the camera type.

The default type is Dali::Camera::FREE_LOOK .0

Parameters
[in]typeThe camera type

Definition at line 176 of file camera-actor-impl.cpp.

References mCameraAttachment.

Member Data Documentation

CameraAttachmentPtr Dali::Internal::CameraActor::mCameraAttachment
private

The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali