Contains property types of Constraints. More...

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

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

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

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

static AbstractBindingSharedPtr	createOrientationBinding (Domain *domain, string_view targetRelativePath)
	Creates a binding for orientation constraint. More...

static AbstractBindingSharedPtr	createPositionBinding (Domain *domain, string_view targetRelativePath)
	Creates a binding for position constraint. More...

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

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

static FaceToCameraMode	getFaceToCameraMode (const Object &object)
	Gets the value of the FaceToCameraModeProperty of a 3D node. More...

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

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static void	setFaceToCameraMode (Object &object, FaceToCameraMode value)
	Sets the value of the FaceToCameraModeProperty. More...

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

Properties
enum	FaceToCameraMode { Disabled, LookAt, Billboard, Cylindrical }
	Specifies the options for setting a 3D node to turn towards a camera. More...

static PropertyType< string >	PositionProperty
	Position property. More...

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

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

static PropertyType< FaceToCameraMode >	FaceToCameraModeProperty
	Sets how a 3D node rotates to turn towards the camera that you set with the FaceToCameraTargetCameraProperty. More...

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

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

Detailed Description

Contains property types of Constraints.

Member Enumeration Documentation

◆ FaceToCameraMode

enum kanzi::Constraints::FaceToCameraMode

Specifies the options for setting a 3D node to turn towards a camera.

Since: Kanzi 3.9.4

Enumerator
Disabled	Does not make the node turn towards the camera.
LookAt	Rotates the node along all axes to turn towards the camera.
Billboard	Keeps the node perpendicular to the camera field of view.
Cylindrical	Rotates the node along the y axis to turn towards the camera.

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.

◆ getFaceToCameraMode()

static FaceToCameraMode kanzi::Constraints::getFaceToCameraMode ( const Object & object )

inlinestatic

Gets the value of the FaceToCameraModeProperty of a 3D node.

Parameters

object An object.

Returns: The value of the FaceToCameraModeProperty.

◆ setFaceToCameraMode()

static void kanzi::Constraints::setFaceToCameraMode	(	Object &	object,
		FaceToCameraMode	value
	)

inlinestatic

Sets the value of the FaceToCameraModeProperty.

Parameters

object	An object.
value	Value of FaceToCameraMode property.

◆ createPositionBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createPositionBinding	(	Domain *	domain,
		string_view	targetRelativePath
	)

static

Creates a binding for position constraint.

Parameters

domain	Domain to use.
targetRelativePath	Path to target node to track.

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

◆ createOrientationBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createOrientationBinding	(	Domain *	domain,
		string_view	targetRelativePath
	)

static

Creates a binding for orientation constraint.

Parameters

domain	Domain to use.
targetRelativePath	Path to target node to track.

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

◆ createLookAtBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createLookAtBinding	(	Domain *	domain,
		string_view	targetRelativePath
	)

static

Creates a binding for look at -constraint.

Parameters

domain	Domain to use.
targetRelativePath	Path to target node to track.

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

◆ createReversedLookAtBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createReversedLookAtBinding	(	Domain *	domain,
		string_view	targetRelativePath
	)

static

Creates a binding for reversed look at -constraint.

Parameters

domain	Domain to use.
targetRelativePath	Path to target node to track.

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

◆ createReversedCylindricalLookAtBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createReversedCylindricalLookAtBinding	(	Domain *	domain,
		string_view	targetRelativePath
	)

static

Creates a binding for cylindrical look at -constraint.

Parameters

domain	Domain to use.
targetRelativePath	Path to target node to track.

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

◆ createLocalPositionBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createLocalPositionBinding	(	Domain *	domain,
		string_view	targetRelativePath
	)

static

Creates a binding for local position constraint.

Parameters

domain	Domain to use.
targetRelativePath	Path to target node to track.

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

◆ createLocalOrientationBinding()

static AbstractBindingSharedPtr kanzi::Constraints::createLocalOrientationBinding	(	Domain *	domain,
		string_view	targetRelativePath
	)

static

Creates a binding for local orientation constraint.

Parameters

domain	Domain to use.
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()

◆ FaceToCameraModeProperty

PropertyType<FaceToCameraMode> kanzi::Constraints::FaceToCameraModeProperty

static

Sets how a 3D node rotates to turn towards the camera that you set with the FaceToCameraTargetCameraProperty.

The default value is Disabled.

See also: setFaceToCameraMode(), getFaceToCameraMode()

◆ 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/constraint.hpp

Static Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ FaceToCameraMode

Member Function Documentation

◆ makeEditorInfo()

◆ isInWorldCoordinates()

◆ setInWorldCoordinates()

◆ getFaceToCameraMode()

◆ setFaceToCameraMode()

◆ createPositionBinding()

◆ createOrientationBinding()

◆ createLookAtBinding()

◆ createReversedLookAtBinding()

◆ createReversedCylindricalLookAtBinding()

◆ createLocalPositionBinding()

◆ createLocalOrientationBinding()

Member Data Documentation

◆ PositionProperty

◆ OrientationProperty

◆ InWorldCoordinatesProperty

◆ FaceToCameraModeProperty

◆ FaceToCameraTargetCameraProperty

◆ LookAtProperty