Kanzi Framework  3.9.0
Kanzi Engine API
page_properties.h File Reference

Functions

float getRotationOffset () const
 Gets the value of RotationOffsetProperty. More...
 
Vector2 getScaleOffset () const
 Gets the value of ScaleOffsetProperty. More...
 
Vector2 getSlideOffset () const
 Gets the value of SlideOffsetProperty. More...
 
float getTransitionPhase () const
 Gets the value of TransitionPhaseProperty. More...
 
bool isAutoActivate () const
 Gets the value of AutoActivateProperty. More...
 
bool isState () const
 Gets the value of StateProperty. More...
 
void setAutoActivate (bool value)
 Sets the value of AutoActivateProperty. More...
 
void setRotationOffset (float value)
 Sets the value of RotationOffsetProperty. More...
 
void setScaleOffset (Vector2 value)
 Sets the value of ScaleOffsetProperty. More...
 
void setSlideOffset (Vector2 value)
 Sets the value of SlideOffsetProperty. More...
 
void setState (bool value)
 Sets the value of StateProperty. More...
 
void setTransitionPhase (float value)
 Sets the value of TransitionPhaseProperty. More...
 

Variables

static PropertyType< bool > AutoActivateProperty
 AutoActivate property. More...
 
static PropertyType< float > RotationOffsetProperty
 RotationOffset property. More...
 
static PropertyType< Vector2 > ScaleOffsetProperty
 ScaleOffset property. More...
 
static PropertyType< Vector2 > SlideOffsetProperty
 SlideOffset property. More...
 
static PropertyType< bool > StateProperty
 State property. More...
 
static PropertyType< float > TransitionPhaseProperty
 TransitionPhase property. More...
 

Function Documentation

◆ isState()

bool isState ( ) const

Gets the value of StateProperty.

See also
setState()

◆ setState()

void setState ( bool  value)

Sets the value of StateProperty.

See also
isState()

◆ getTransitionPhase()

float getTransitionPhase ( ) const

Gets the value of TransitionPhaseProperty.

See also
setTransitionPhase()

◆ setTransitionPhase()

void setTransitionPhase ( float  value)

Sets the value of TransitionPhaseProperty.

See also
getTransitionPhase()

◆ isAutoActivate()

bool isAutoActivate ( ) const

Gets the value of AutoActivateProperty.

See also
setAutoActivate()

◆ setAutoActivate()

void setAutoActivate ( bool  value)

Sets the value of AutoActivateProperty.

See also
isAutoActivate()

◆ getSlideOffset()

Vector2 getSlideOffset ( ) const

Gets the value of SlideOffsetProperty.

See also
setSlideOffset()

◆ setSlideOffset()

void setSlideOffset ( Vector2  value)

Sets the value of SlideOffsetProperty.

See also
getSlideOffset()

◆ getScaleOffset()

Vector2 getScaleOffset ( ) const

Gets the value of ScaleOffsetProperty.

See also
setScaleOffset()

◆ setScaleOffset()

void setScaleOffset ( Vector2  value)

Sets the value of ScaleOffsetProperty.

See also
getScaleOffset()

◆ getRotationOffset()

float getRotationOffset ( ) const

Gets the value of RotationOffsetProperty.

See also
setRotationOffset()

◆ setRotationOffset()

void setRotationOffset ( float  value)

Sets the value of RotationOffsetProperty.

See also
getRotationOffset()

Variable Documentation

◆ StateProperty

PropertyType<bool> StateProperty
static

State property.

The state of this Page node: false (inactive and invisible) or true (active and visible) (read-only). The default value is false.

See also
setState(), isState()

◆ TransitionPhaseProperty

PropertyType<float> TransitionPhaseProperty
static

TransitionPhase property.

The phase of the transition. For example, use for pixel-based effects. The default value is 0.0f.

See also
setTransitionPhase(), getTransitionPhase()

◆ AutoActivateProperty

PropertyType<bool> AutoActivateProperty
static

AutoActivate property.

Always activate this Page node when its parent is active. The default value is false.

See also
setAutoActivate(), isAutoActivate()

◆ SlideOffsetProperty

PropertyType<Vector2> SlideOffsetProperty
static

SlideOffset property.

The offset to slide a Page node in horizontal or vertical direction:

  • X [-1, 1] to move the Page node horizontally.
  • Y [-1, 1] to move the Page node vertically.

The default value is Vector2(0.0f, 0.0f).

See also
setSlideOffset(), getSlideOffset()

◆ ScaleOffsetProperty

PropertyType<Vector2> ScaleOffsetProperty
static

ScaleOffset property.

The factor by which to scale a Page node. The default value is Vector2(1.0f, 1.0f).

See also
setScaleOffset(), getScaleOffset()

◆ RotationOffsetProperty

PropertyType<float> RotationOffsetProperty
static

RotationOffset property.

The angle in degrees by which to rotate a Page node. The default value is 0.0f.

See also
setRotationOffset(), getRotationOffset()