Murl::Graph::IPlaneTouchArea Interface Referenceabstract

The IPlaneTouchArea graph node interface. More...

#include "murl_graph_i_plane_touch_area.h"

Inheritance diagram for Murl::Graph::IPlaneTouchArea:

Public Member Functions

virtual INodeGetNodeInterface ()=0
 Get the mutable Graph::INode interface. More...
 
virtual const INodeGetNodeInterface () const =0
 Get the constant Graph::INode interface. More...
 
virtual ITransformGetTransformInterface ()=0
 Get the mutable Graph::ITransform interface. More...
 
virtual const ITransformGetTransformInterface () const =0
 Get the constant Graph::ITransform interface. More...
 
virtual ITouchAreaGetTouchAreaInterface ()=0
 Get the mutable Graph::ITouchArea interface. More...
 
virtual const ITouchAreaGetTouchAreaInterface () const =0
 Get the constant Graph::ITouchArea interface. More...
 
virtual Bool SetShape (IEnums::TouchAreaShape shape)=0
 Set the shape of the touch area. More...
 
virtual IEnums::TouchAreaShape GetShape () const =0
 Get the shape of the touch area. More...
 
virtual Bool SetFrameSize (Real sizeX, Real sizeY)=0
 Set the size of the display rectangle. More...
 
virtual Bool SetFrameSizeX (Real sizeX)=0
 Set the width of the display rectangle. More...
 
virtual Bool SetFrameSizeY (Real sizeY)=0
 Set the height of the display rectangle. More...
 
virtual Real GetFrameSizeX () const =0
 Get the width of the display rectangle. More...
 
virtual Real GetFrameSizeY () const =0
 Get the height of the display rectangle. More...
 
virtual Bool SetContainerAlignment (IEnums::AlignmentX alignmentX, IEnums::AlignmentY alignmentY)=0
 Set the horizontal container alignment. More...
 
virtual Bool SetContainerAlignmentX (IEnums::AlignmentX alignmentX)=0
 Set the horizontal container alignment. More...
 
virtual Bool SetContainerAlignmentY (IEnums::AlignmentY alignmentY)=0
 Set the vertical container alignment. More...
 
virtual IEnums::AlignmentX GetContainerAlignmentX () const =0
 Get the horizontal container alignment. More...
 
virtual IEnums::AlignmentY GetContainerAlignmentY () const =0
 Get the vertical container alignment. More...
 
virtual Bool SetBorder (Real borderX, Real borderY)=0
 Set the horizontal and vertical borders used for alignment. More...
 
virtual Bool SetBorderX (Real borderX)=0
 Set the horizontal border used for alignment. More...
 
virtual Bool SetBorderY (Real borderY)=0
 Set the vertical border used for alignment. More...
 
virtual Real GetBorderX () const =0
 Get the horizontal border used for alignment. More...
 
virtual Real GetBorderY () const =0
 Get the vertical border used for alignment. More...
 
- Public Member Functions inherited from Murl::Graph::IScalable
virtual Bool SetScaleFactor (const Vector &scaleFactor)=0
 Set individual scaling factors for the X, Y and Z axes. More...
 
virtual Bool SetScaleFactor (Real x, Real y, Real z)=0
 Set individual scaling factors for the X, Y and Z axes. More...
 
virtual Bool SetScaleFactor (Real s)=0
 Set a uniform scaling factor for all three axes. More...
 
virtual Bool SetScaleFactorX (Real x)=0
 Set the scaling factor for the X axis only. More...
 
virtual Bool SetScaleFactorY (Real y)=0
 Set the scaling factor for the Y axis only. More...
 
virtual Bool SetScaleFactorZ (Real z)=0
 Set the scaling factor for the Z axis only. More...
 
virtual const VectorGetScaleFactor () const =0
 Get the scaling factors for the X, Y and Z axes. More...
 
virtual Real GetScaleFactorX () const =0
 Get the scaling factor for the X axis. More...
 
virtual Real GetScaleFactorY () const =0
 Get the scaling factor for the Y axis. More...
 
virtual Real GetScaleFactorZ () const =0
 Get the scaling factor for the Z axis. More...
 

Detailed Description

The IPlaneTouchArea graph node interface.

This interface represents a flat rectangular or elliptical input object in world space, with unit size dimensions around the origin.

Use the Graph::IScalable base interface to set an overall scaling factor for the plane, i.e. define its actual size.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IPlaneTouchArea::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.

Returns
The mutable Graph::INode interface, or null if not available

◆ GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::IPlaneTouchArea::GetNodeInterface ( ) const
pure virtual

Get the constant Graph::INode interface.

This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Returns
The constant Graph::INode interface, or null if not available

◆ GetTransformInterface() [1/2]

virtual ITransform* Murl::Graph::IPlaneTouchArea::GetTransformInterface ( )
pure virtual

Get the mutable Graph::ITransform interface.

This method returns a mutable pointer to the node's Graph::ITransform interface, to be able to query or modify the node's transformation matrix and depth order.

Returns
The mutable Graph::ITransform interface, or null if not available

◆ GetTransformInterface() [2/2]

virtual const ITransform* Murl::Graph::IPlaneTouchArea::GetTransformInterface ( ) const
pure virtual

Get the constant Graph::ITransform interface.

This method returns a constant pointer to the node's Graph::ITransform interface, to be able to query the node's transformation matrix and depth order.

Returns
The constant Graph::ITransform interface, or null if not available

◆ GetTouchAreaInterface() [1/2]

virtual ITouchArea* Murl::Graph::IPlaneTouchArea::GetTouchAreaInterface ( )
pure virtual

Get the mutable Graph::ITouchArea interface.

This method returns a mutable pointer to the node's Graph::ITouchArea interface, to be able to access the node's base touch area functionality.

Returns
The mutable Graph::ITouchArea interface, or null if not available

◆ GetTouchAreaInterface() [2/2]

virtual const ITouchArea* Murl::Graph::IPlaneTouchArea::GetTouchAreaInterface ( ) const
pure virtual

Get the constant Graph::ITouchArea interface.

This method returns a constant pointer to the node's Graph::ITouchArea interface, to be able to access the node's base touch area functionality.

Returns
The constant Graph::ITouchArea interface, or null if not available

◆ SetShape()

virtual Bool Murl::Graph::IPlaneTouchArea::SetShape ( IEnums::TouchAreaShape  shape)
pure virtual

Set the shape of the touch area.

Parameters
shapeThe shape to use.
Returns
true if successful.

◆ GetShape()

virtual IEnums::TouchAreaShape Murl::Graph::IPlaneTouchArea::GetShape ( ) const
pure virtual

Get the shape of the touch area.

Returns
The touch area's shape.

◆ SetFrameSize()

virtual Bool Murl::Graph::IPlaneTouchArea::SetFrameSize ( Real  sizeX,
Real  sizeY 
)
pure virtual

Set the size of the display rectangle.

Parameters
sizeXThe rectangle width.
sizeYThe rectangle height.
Returns
true if successful.

◆ SetFrameSizeX()

virtual Bool Murl::Graph::IPlaneTouchArea::SetFrameSizeX ( Real  sizeX)
pure virtual

Set the width of the display rectangle.

Parameters
sizeXThe rectangle width.
Returns
true if successful.

◆ SetFrameSizeY()

virtual Bool Murl::Graph::IPlaneTouchArea::SetFrameSizeY ( Real  sizeY)
pure virtual

Set the height of the display rectangle.

Parameters
sizeYThe rectangle height.
Returns
true if successful.

◆ GetFrameSizeX()

virtual Real Murl::Graph::IPlaneTouchArea::GetFrameSizeX ( ) const
pure virtual

Get the width of the display rectangle.

Returns
The rectangle width.

◆ GetFrameSizeY()

virtual Real Murl::Graph::IPlaneTouchArea::GetFrameSizeY ( ) const
pure virtual

Get the height of the display rectangle.

Returns
The rectangle height.

◆ SetContainerAlignment()

virtual Bool Murl::Graph::IPlaneTouchArea::SetContainerAlignment ( IEnums::AlignmentX  alignmentX,
IEnums::AlignmentY  alignmentY 
)
pure virtual

Set the horizontal container alignment.

The given alignment values specify how the touch area is actually positioned with respect to the node's world position.

Parameters
alignmentXThe horizontal container alignment.
alignmentYThe vertical container alignment.
Returns
true if successful.

◆ SetContainerAlignmentX()

virtual Bool Murl::Graph::IPlaneTouchArea::SetContainerAlignmentX ( IEnums::AlignmentX  alignmentX)
pure virtual

Set the horizontal container alignment.

See SetContainerAlignment().

Parameters
alignmentXThe horizontal container alignment.
Returns
true if successful.

◆ SetContainerAlignmentY()

virtual Bool Murl::Graph::IPlaneTouchArea::SetContainerAlignmentY ( IEnums::AlignmentY  alignmentY)
pure virtual

Set the vertical container alignment.

See SetContainerAlignment().

Parameters
alignmentYThe vertical container alignment.
Returns
true if successful.

◆ GetContainerAlignmentX()

virtual IEnums::AlignmentX Murl::Graph::IPlaneTouchArea::GetContainerAlignmentX ( ) const
pure virtual

Get the horizontal container alignment.

Returns
The horizontal container alignment.

◆ GetContainerAlignmentY()

virtual IEnums::AlignmentY Murl::Graph::IPlaneTouchArea::GetContainerAlignmentY ( ) const
pure virtual

Get the vertical container alignment.

Returns
The vertical container alignment.

◆ SetBorder()

virtual Bool Murl::Graph::IPlaneTouchArea::SetBorder ( Real  borderX,
Real  borderY 
)
pure virtual

Set the horizontal and vertical borders used for alignment.

Parameters
borderXThe horizontal border.
borderYThe vertical border.
Returns
true if successful.

◆ SetBorderX()

virtual Bool Murl::Graph::IPlaneTouchArea::SetBorderX ( Real  borderX)
pure virtual

Set the horizontal border used for alignment.

Parameters
borderXThe horizontal border.
Returns
true if successful.

◆ SetBorderY()

virtual Bool Murl::Graph::IPlaneTouchArea::SetBorderY ( Real  borderY)
pure virtual

Set the vertical border used for alignment.

Parameters
borderYThe vertical border.
Returns
true if successful.

◆ GetBorderX()

virtual Real Murl::Graph::IPlaneTouchArea::GetBorderX ( ) const
pure virtual

Get the horizontal border used for alignment.

Returns
The horizontal border.

◆ GetBorderY()

virtual Real Murl::Graph::IPlaneTouchArea::GetBorderY ( ) const
pure virtual

Get the vertical border used for alignment.

Returns
The vertical border.

The documentation for this interface was generated from the following file:
  • murl_graph_i_plane_touch_area.h


Copyright © 2011-2022 Spraylight GmbH.