The INinePatch property interface. More...

#include "murl_graph_i_nine_patch.h"

Inheritance diagram for Murl::Graph::INinePatch:

Public Member Functions

virtual Bool SetCapCoordSize (Real x1, Real y1, Real x2, Real y2)=0
 Set all four of the cap coordinate sizes. More...
 
virtual Bool SetCapCoordSize1 (Real x1, Real y1)=0
 Set the cap coordinate start sizes. More...
 
virtual Bool SetCapCoordSize2 (Real x2, Real y2)=0
 Set the cap coordinate stop sizes. More...
 
virtual Bool SetCapCoordSizeX1 (Real x1)=0
 Set the left cap coordinate size. More...
 
virtual Bool SetCapCoordSizeY1 (Real y1)=0
 Set the bottom cap coordinate size. More...
 
virtual Bool SetCapCoordSizeX2 (Real x2)=0
 Set the right cap coordinate size. More...
 
virtual Bool SetCapCoordSizeY2 (Real y2)=0
 Set the top cap coordinate size. More...
 
virtual Real GetCapCoordSizeX1 () const =0
 Get the left cap coordinate size. More...
 
virtual Real GetCapCoordSizeY1 () const =0
 Get the bottom cap coordinate size. More...
 
virtual Real GetCapCoordSizeX2 () const =0
 Get the right cap coordinate size. More...
 
virtual Real GetCapCoordSizeY2 () const =0
 Get the top cap coordinate size. More...
 
virtual Bool SetCapTexCoordSize (Real x1, Real y1, Real x2, Real y2, UInt32 index)=0
 Set all four of the cap texture coordinate sizes. More...
 
virtual Bool SetCapTexCoordSize1 (Real x1, Real y1, UInt32 index)=0
 Set the cap texture coordinate start sizes. More...
 
virtual Bool SetCapTexCoordSize2 (Real x2, Real y2, UInt32 index)=0
 Set the cap texture coordinate stop sizes. More...
 
virtual Bool SetCapTexCoordSizeX1 (Real x1, UInt32 index)=0
 Set the left cap texture coordinate size. More...
 
virtual Bool SetCapTexCoordSizeY1 (Real y1, UInt32 index)=0
 Set the bottom cap texture coordinate size. More...
 
virtual Bool SetCapTexCoordSizeX2 (Real x2, UInt32 index)=0
 Set the right cap texture coordinate size. More...
 
virtual Bool SetCapTexCoordSizeY2 (Real y2, UInt32 index)=0
 Set the top cap texture coordinate size. More...
 
virtual Real GetCapTexCoordSizeX1 (UInt32 index) const =0
 Get the left cap texture coordinate size. More...
 
virtual Real GetCapTexCoordSizeY1 (UInt32 index) const =0
 Get the bottom cap texture coordinate size. More...
 
virtual Real GetCapTexCoordSizeX2 (UInt32 index) const =0
 Get the right cap texture coordinate size. More...
 
virtual Real GetCapTexCoordSizeY2 (UInt32 index) const =0
 Get the top cap texture coordinate size. More...
 
virtual Bool SetCenterPatchEnabled (Bool enabled)=0
 Enable/disable rendering of the center patch. More...
 
virtual Bool IsCenterPatchEnabled () const =0
 Check if the center patch is visible. More...
 

Detailed Description

The INinePatch property interface.

This interface represents a generic object that is divided up in three segments along both X and Y axes, creating a total of nine segments.

The first and last segment along each axis is defined with fixed size and texture coordinates, whereas the middle segment is stretched or shrunk depending on the actual plane frame size.

A nine patch is useful for defining the visual appearance of e.g. buttons on screen, which may have different actual sizes but should retain a common (unstretched) look along its corners and edges.

See the Graph::INinePatchPlaneGeometry and Graph::INinePatchPlaneSequenceGeometry node interfaces for further reference.

Member Function Documentation

◆ SetCapCoordSize()

virtual Bool Murl::Graph::INinePatch::SetCapCoordSize ( Real  x1,
Real  y1,
Real  x2,
Real  y2 
)
pure virtual

Set all four of the cap coordinate sizes.

This method sets all four of the cap sizes, i.e. left/right and bottom/top caps. Note that (x1+x2) and (y1+y2) should be less or equal to the object's actual frame size along the respective axis, defined via e.g. Graph::IPlaneGeometry::SetFrameSize().

Parameters
x1The left cap size.
y1The bottom cap size.
x2The right cap size.
y2The top cap size.
Returns
true if successful.

◆ SetCapCoordSize1()

virtual Bool Murl::Graph::INinePatch::SetCapCoordSize1 ( Real  x1,
Real  y1 
)
pure virtual

Set the cap coordinate start sizes.

This method sets the left and bottom cap sizes. See SetCapCoordSize().

Parameters
x1The left cap size.
y1The bottom cap size.
Returns
true if successful.

◆ SetCapCoordSize2()

virtual Bool Murl::Graph::INinePatch::SetCapCoordSize2 ( Real  x2,
Real  y2 
)
pure virtual

Set the cap coordinate stop sizes.

This method sets the right and top cap sizes. See SetCapCoordSize().

Parameters
x2The right cap size.
y2The top cap size.
Returns
true if successful.

◆ SetCapCoordSizeX1()

virtual Bool Murl::Graph::INinePatch::SetCapCoordSizeX1 ( Real  x1)
pure virtual

Set the left cap coordinate size.

See SetCapCoordSize().

Parameters
x1The left cap size.
Returns
true if successful.

◆ SetCapCoordSizeY1()

virtual Bool Murl::Graph::INinePatch::SetCapCoordSizeY1 ( Real  y1)
pure virtual

Set the bottom cap coordinate size.

See SetCapCoordSize().

Parameters
y1The bottom cap size.
Returns
true if successful.

◆ SetCapCoordSizeX2()

virtual Bool Murl::Graph::INinePatch::SetCapCoordSizeX2 ( Real  x2)
pure virtual

Set the right cap coordinate size.

See SetCapCoordSize().

Parameters
x2The right cap size.
Returns
true if successful.

◆ SetCapCoordSizeY2()

virtual Bool Murl::Graph::INinePatch::SetCapCoordSizeY2 ( Real  y2)
pure virtual

Set the top cap coordinate size.

See SetCapCoordSize().

Parameters
y2The top cap size.
Returns
true if successful.

◆ GetCapCoordSizeX1()

virtual Real Murl::Graph::INinePatch::GetCapCoordSizeX1 ( ) const
pure virtual

Get the left cap coordinate size.

Returns
The left cap size.

◆ GetCapCoordSizeY1()

virtual Real Murl::Graph::INinePatch::GetCapCoordSizeY1 ( ) const
pure virtual

Get the bottom cap coordinate size.

Returns
The bottom cap size.

◆ GetCapCoordSizeX2()

virtual Real Murl::Graph::INinePatch::GetCapCoordSizeX2 ( ) const
pure virtual

Get the right cap coordinate size.

Returns
The right cap size.

◆ GetCapCoordSizeY2()

virtual Real Murl::Graph::INinePatch::GetCapCoordSizeY2 ( ) const
pure virtual

Get the top cap coordinate size.

Returns
The top cap size.

◆ SetCapTexCoordSize()

virtual Bool Murl::Graph::INinePatch::SetCapTexCoordSize ( Real  x1,
Real  y1,
Real  x2,
Real  y2,
UInt32  index 
)
pure virtual

Set all four of the cap texture coordinate sizes.

This method sets all four of the texture coordinate cap sizes, i.e. left/right and bottom/top caps.

Parameters
x1The left cap texture coordinate size.
y1The bottom cap texture coordinate size.
x2The right cap texture coordinate size.
y2The top cap texture coordinate size.
indexThe index of the texture coordinate set.
Returns
true if successful.

◆ SetCapTexCoordSize1()

virtual Bool Murl::Graph::INinePatch::SetCapTexCoordSize1 ( Real  x1,
Real  y1,
UInt32  index 
)
pure virtual

Set the cap texture coordinate start sizes.

This method sets the left and bottom texture coordinate cap sizes.

Parameters
x1The left cap texture coordinate size.
y1The bottom cap texture coordinate size.
indexThe index of the texture coordinate set.
Returns
true if successful.

◆ SetCapTexCoordSize2()

virtual Bool Murl::Graph::INinePatch::SetCapTexCoordSize2 ( Real  x2,
Real  y2,
UInt32  index 
)
pure virtual

Set the cap texture coordinate stop sizes.

This method sets the left and bottom texture coordinate cap sizes.

Parameters
x2The right cap texture coordinate size.
y2The top cap texture coordinate size.
indexThe index of the texture coordinate set.
Returns
true if successful.

◆ SetCapTexCoordSizeX1()

virtual Bool Murl::Graph::INinePatch::SetCapTexCoordSizeX1 ( Real  x1,
UInt32  index 
)
pure virtual

Set the left cap texture coordinate size.

Parameters
x1The left cap texture coordinate size.
indexThe index of the texture coordinate set.
Returns
true if successful.

◆ SetCapTexCoordSizeY1()

virtual Bool Murl::Graph::INinePatch::SetCapTexCoordSizeY1 ( Real  y1,
UInt32  index 
)
pure virtual

Set the bottom cap texture coordinate size.

Parameters
y1The bottom cap texture coordinate size.
indexThe index of the texture coordinate set.
Returns
true if successful.

◆ SetCapTexCoordSizeX2()

virtual Bool Murl::Graph::INinePatch::SetCapTexCoordSizeX2 ( Real  x2,
UInt32  index 
)
pure virtual

Set the right cap texture coordinate size.

Parameters
x2The right cap texture coordinate size.
indexThe index of the texture coordinate set.
Returns
true if successful.

◆ SetCapTexCoordSizeY2()

virtual Bool Murl::Graph::INinePatch::SetCapTexCoordSizeY2 ( Real  y2,
UInt32  index 
)
pure virtual

Set the top cap texture coordinate size.

Parameters
y2The top cap texture coordinate size.
indexThe index of the texture coordinate set.
Returns
true if successful.

◆ GetCapTexCoordSizeX1()

virtual Real Murl::Graph::INinePatch::GetCapTexCoordSizeX1 ( UInt32  index) const
pure virtual

Get the left cap texture coordinate size.

Parameters
indexThe index of the texture coordinate set.
Returns
The left cap texture coordinate size.

◆ GetCapTexCoordSizeY1()

virtual Real Murl::Graph::INinePatch::GetCapTexCoordSizeY1 ( UInt32  index) const
pure virtual

Get the bottom cap texture coordinate size.

Parameters
indexThe index of the texture coordinate set.
Returns
The bottom cap texture coordinate size.

◆ GetCapTexCoordSizeX2()

virtual Real Murl::Graph::INinePatch::GetCapTexCoordSizeX2 ( UInt32  index) const
pure virtual

Get the right cap texture coordinate size.

Parameters
indexThe index of the texture coordinate set.
Returns
The right cap texture coordinate size.

◆ GetCapTexCoordSizeY2()

virtual Real Murl::Graph::INinePatch::GetCapTexCoordSizeY2 ( UInt32  index) const
pure virtual

Get the top cap texture coordinate size.

Parameters
indexThe index of the texture coordinate set.
Returns
The top cap texture coordinate size.

◆ SetCenterPatchEnabled()

virtual Bool Murl::Graph::INinePatch::SetCenterPatchEnabled ( Bool  enabled)
pure virtual

Enable/disable rendering of the center patch.

To avoid excessive overdraw when e.g. only a frame with transparent center is to be rendered, the center patch can be set invisible using this method.

Parameters
enabledIf false, the center patch is not rendered.
Returns
true if successful.

◆ IsCenterPatchEnabled()

virtual Bool Murl::Graph::INinePatch::IsCenterPatchEnabled ( ) const
pure virtual

Check if the center patch is visible.

Returns
true if visible.

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


Copyright © 2011-2018 Spraylight GmbH.