Contains property types of Constraints. More...

#include <kanzi/core.ui/constraints/constraints.hpp>

Static Public Member Functions
static AbstractBindingSharedPtr	createLocalOrientationBinding (string_view targetRelativePath)
	Creates a binding for local orientation constraint. More...

static AbstractBindingSharedPtr	createLocalPositionBinding (string_view targetRelativePath)
	Creates a binding for local position constraint. More...

static AbstractBindingSharedPtr	createLookAtBinding (string_view targetRelativePath)
	Creates a binding for look at -constraint. More...

static AbstractBindingSharedPtr	createOrientationBinding (string_view targetRelativePath)
	Creates a binding for orientation constraint. More...

static AbstractBindingSharedPtr	createPositionBinding (string_view targetRelativePath)
	Creates a binding for position constraint. More...

static AbstractBindingSharedPtr	createReversedCylindricalLookAtBinding (string_view targetRelativePath)
	Creates a binding for cylindrical look at -constraint. More...

static AbstractBindingSharedPtr	createReversedLookAtBinding (string_view targetRelativePath)
	Creates a binding for reversed look at -constraint. More...

static bool	isFaceToCamera (const Object &object)
	Gets the value of FaceToCamera property of object. More...

static bool	isFaceToCameraBillboarding (const Object &object)
	Gets the value of FaceToCameraIsBillboarding property of object. More...

static bool	isFaceToCameraCylindral (const Object &object)
	Gets the value of FaceToCameraIsCylindral property of object. More...

static bool	isInWorldCoordinates (const Object &object)
	Gets the value of InWorldCoordinates property of object. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static void	setFaceToCamera (Object &object, bool value)
	Sets the value of FaceToCamera property of object. More...

static void	setFaceToCameraIsBillboarding (Object &object, bool value)
	Sets the value of FaceToCameraIsBillboarding property of object. More...

static void	setFaceToCameraIsCylindral (Object &object, bool value)
	Sets the value of FaceToCameraIsCylindral property of object. More...

static void	setInWorldCoordinates (Object &object, bool value)
	Sets the value of InWorldCoordinates property of object. More...

Static Public Attributes
Properties
static PropertyType< string >	PositionProperty
	Position property. More...

static PropertyType< string >	OrientationProperty
	Orientation property. More...

static PropertyType< bool >	InWorldCoordinatesProperty
	InWorldCoordinates property. More...

static PropertyType< bool >	FaceToCameraProperty
	FaceToCamera property. More...

static PropertyType< bool >	FaceToCameraIsBillboardingProperty
	FaceToCameraIsBillboarding property. More...

static PropertyType< bool >	FaceToCameraCylindralProperty
	FaceToCameraCylindral property. More...

static PropertyType< string >	FaceToCameraTargetCameraProperty
	FaceToCameraTargetCamera property. More...

static PropertyType< string >	LookAtProperty
	LookAt property. More...

Detailed Description

Contains property types of Constraints.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Constraints::makeEditorInfo ( )

static

◆ isInWorldCoordinates()

static bool kanzi::Constraints::isInWorldCoordinates ( const Object & object )

inlinestatic

Gets the value of InWorldCoordinates property of object.

Parameters

object An object.

Returns: Returns value of the InWorldCoordinates property.

◆ setInWorldCoordinates()

static void kanzi::Constraints::setInWorldCoordinates	(	Object &	object,
		bool	value
	)

inlinestatic

Sets the value of InWorldCoordinates property of object.

Parameters

object	An object.
value	Value of InWorldCoordinatesColor property.

◆ isFaceToCamera()

static bool kanzi::Constraints::isFaceToCamera ( const Object & object )

inlinestatic

Gets the value of FaceToCamera property of object.

Parameters

object An object.

Returns: Returns value of the FaceToCamera property.

◆ setFaceToCamera()

static void kanzi::Constraints::setFaceToCamera	(	Object &	object,
		bool	value
	)

inlinestatic

Sets the value of FaceToCamera property of object.

Parameters

object	An object.
value	Value of FaceToCameraColor property.

◆ isFaceToCameraBillboarding()

static bool kanzi::Constraints::isFaceToCameraBillboarding ( const Object & object )

inlinestatic

Gets the value of FaceToCameraIsBillboarding property of object.

Parameters

object An object.

Returns: Returns value of the FaceToCameraIsBillboarding property.

◆ setFaceToCameraIsBillboarding()

static void kanzi::Constraints::setFaceToCameraIsBillboarding	(	Object &	object,
		bool	value
	)

inlinestatic

Sets the value of FaceToCameraIsBillboarding property of object.

Parameters

object	An object.
value	Value of FaceToCameraIsBillboardingColor property.

◆ isFaceToCameraCylindral()

static bool kanzi::Constraints::isFaceToCameraCylindral ( const Object & object )

inlinestatic

Gets the value of FaceToCameraIsCylindral property of object.

Parameters

object An object.

Returns: Returns value of the FaceToCameraIsCylindral property.

◆ setFaceToCameraIsCylindral()

static void kanzi::Constraints::setFaceToCameraIsCylindral	(	Object &	object,
		bool	value
	)

inlinestatic

Sets the value of FaceToCameraIsCylindral property of object.

Parameters

object	An object.
value	Value of FaceToCameraIsCylindralColor property.

◆ createPositionBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createPositionBinding ( string_view targetRelativePath )

static

Creates a binding for position constraint.

Parameters

targetRelativePath Path to target node to track.

Returns: Binding to add to the node with the constraint.

◆ createOrientationBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createOrientationBinding ( string_view targetRelativePath )

static

Creates a binding for orientation constraint.

Parameters

targetRelativePath Path to target node to track.

Returns: Binding to add to the node with the constraint.

◆ createLookAtBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createLookAtBinding ( string_view targetRelativePath )

static

Creates a binding for look at -constraint.

Parameters

targetRelativePath Path to target node to track.

Returns: Binding to add to the node with the constraint.

◆ createReversedLookAtBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createReversedLookAtBinding ( string_view targetRelativePath )

static

Creates a binding for reversed look at -constraint.

Parameters

targetRelativePath Path to target node to track.

Returns: Binding to add to the node with the constraint.

◆ createReversedCylindricalLookAtBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createReversedCylindricalLookAtBinding ( string_view targetRelativePath )

static

Creates a binding for cylindrical look at -constraint.

Parameters

targetRelativePath Path to target node to track.

Returns: Binding to add to the node with the constraint.

◆ createLocalPositionBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createLocalPositionBinding ( string_view targetRelativePath )

static

Creates a binding for local position constraint.

Parameters

targetRelativePath Path to target node to track.

Returns: Binding to add to the node with the constraint.

◆ createLocalOrientationBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createLocalOrientationBinding ( string_view targetRelativePath )

static

Creates a binding for local orientation constraint.

Parameters

targetRelativePath Path to target node to track.

Returns: Binding to add to the node with the constraint.

Member Data Documentation

◆ PositionProperty

PropertyType<string> kanzi::Constraints::PositionProperty

static

Position property.

The default value is "".

See also: setPosition(), getPosition()

◆ OrientationProperty

PropertyType<string> kanzi::Constraints::OrientationProperty

static

Orientation property.

The default value is "".

See also: setOrientation(), getOrientation()

◆ InWorldCoordinatesProperty

PropertyType<bool> kanzi::Constraints::InWorldCoordinatesProperty

static

InWorldCoordinates property.

The default value is false.

See also: setInWorldCoordinates(), isInWorldCoordinates()

◆ FaceToCameraProperty

PropertyType<bool> kanzi::Constraints::FaceToCameraProperty

static

FaceToCamera property.

The default value is false.

See also: setFaceToCamera(), isFaceToCamera()

◆ FaceToCameraIsBillboardingProperty

PropertyType<bool> kanzi::Constraints::FaceToCameraIsBillboardingProperty

static

FaceToCameraIsBillboarding property.

The default value is true.

See also: setFaceToCameraIsBillboarding(), isFaceToCameraIsBillboarding()

◆ FaceToCameraCylindralProperty

PropertyType<bool> kanzi::Constraints::FaceToCameraCylindralProperty

static

FaceToCameraCylindral property.

The default value is false.

See also: setFaceToCameraCylindral(), isFaceToCameraCylindral()

◆ FaceToCameraTargetCameraProperty

PropertyType<string> kanzi::Constraints::FaceToCameraTargetCameraProperty

static

FaceToCameraTargetCamera property.

The default value is "".

See also: setFaceToCameraTargetCamera(), getFaceToCameraTargetCamera()

◆ LookAtProperty

PropertyType<string> kanzi::Constraints::LookAtProperty

static

LookAt property.

The default value is "".

See also: setLookAt(), getLookAt()

The documentation for this class was generated from the following file:

kanzi/core.ui/constraints/constraints.hpp

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ makeEditorInfo()

◆ isInWorldCoordinates()

◆ setInWorldCoordinates()

◆ isFaceToCamera()

◆ setFaceToCamera()

◆ isFaceToCameraBillboarding()

◆ setFaceToCameraIsBillboarding()

◆ isFaceToCameraCylindral()

◆ setFaceToCameraIsCylindral()

◆ createPositionBinding()

◆ createOrientationBinding()

◆ createLookAtBinding()

◆ createReversedLookAtBinding()

◆ createReversedCylindricalLookAtBinding()

◆ createLocalPositionBinding()

◆ createLocalOrientationBinding()

Member Data Documentation

◆ PositionProperty

◆ OrientationProperty

◆ InWorldCoordinatesProperty

◆ FaceToCameraProperty

◆ FaceToCameraIsBillboardingProperty

◆ FaceToCameraCylindralProperty

◆ FaceToCameraTargetCameraProperty

◆ LookAtProperty