#include <kanzi/core.ui/resource/trajectory.hpp>

Inheritance diagram for kanzi::Trajectory:

Public Types
enum	Type { SplineTrajectory, CircleTrajectory, LineTrajectory }
	Type of trajectory. More...

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
virtual	~Trajectory () KZ_OVERRIDE

Vector3	getPointAbsolute (kzFloat lengthParameter) const
	Gets a point on trajectory by using absolute coordinates ranging from 0.0 to trajectory length. More...

Vector3	getPointRelative (kzFloat phaseParameter) const
	Gets a point on trajectory by using relative coordinates. More...

kzFloat	getLength () const
	Gets length of trajectory. More...

bool	isComplete () const
	Returns true if trajectory is complete and usable. More...

const KzcSpline *	getSpline () const
	Returns spline in case of trajectory having the spline. More...

kzUint	getVisualizationPointCount () const
	Gets the number of counts recommended for visualizing the trajectory. More...

Vector3	getVisualizationPoint (kzUint pointIndex, kzUint pointCount) const
	Gets a visualization point of the trajectory. More...

Type	getType () const
	Return the type of the trajectory. More...

kzFloat	getRadius () const
	Return radius of a circle trajectory. More...

kzFloat	getAngle () const
	Return angle of a circle trajectory. More...

Vector3	getLineDirection () const
	Return direction vector of a line trajectory. More...

Vector3	getCircleNormal () const
	Return normal vector for the plane of a circle trajectory. More...

Vector3	getCircleOrigin () const
	Return origin point of a circle trajectory. More...

Vector3	scalePoint (Vector3 point, const Matrix4x4 &transform, Vector3 scaling) const

virtual void	loadFromKZB (const ResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
	Function for loading the resource from .KZB. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...

virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

void	setNotLoaded ()

bool	isFromKZB () const

void	reload ()

void	reloadFromKzb (KzcInputStream inputStream, const KzuBinaryFileInfo file)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	reloadFromFile (string_view filePath)

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...

void	removeKzbProperties ()

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void owner)

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Static Public Member Functions
static Trajectory *	createEmpty (Domain *domain, string_view name)
	Creates a trajectory with no data. More...

static TrajectorySharedPtr	createCircle (Vector3 origin, Vector3 up, kzFloat angleInDegrees, kzFloat radius, kanzi::Domain *domain, string_view name)
	Creates a circle trajectory. More...

static TrajectorySharedPtr	createLine (Vector3 origin, Vector3 direction, kzFloat length, kanzi::Domain *domain, string_view name)
	Creates a line trajectory. More...

static TrajectorySharedPtr	createSpline (KzcSpline spline, kanzi::Domain domain, string_view name)
	Creates a spline trajectory. More...

static TrajectorySharedPtr	loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Loads a trajectory from a file. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Member Functions inherited from kanzi::Resource
virtual void	reloadOverride ()

virtual void	reloadFromKzbOverride (KzcInputStream inputStream, const KzuBinaryFileInfo file)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadFromFileOverride (string_view filePath)

virtual unsigned int	getCPUMemoryUsageOverride () const

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Member Enumeration Documentation

enum kanzi::Trajectory::Type

Type of trajectory.

Enumerator
SplineTrajectory	Series of points. Spline.
CircleTrajectory	Circle.
LineTrajectory	Line.

Constructor & Destructor Documentation

virtual kanzi::Trajectory::~Trajectory ( )

virtual

Member Function Documentation

static Trajectory* kanzi::Trajectory::createEmpty	(	Domain *	domain,
		string_view	name
	)

static

Creates a trajectory with no data.

static TrajectorySharedPtr kanzi::Trajectory::createCircle	(	Vector3	origin,
		Vector3	up,
		kzFloat	angleInDegrees,
		kzFloat	radius,
		kanzi::Domain *	domain,
		string_view	name
	)

static

Creates a circle trajectory.

Parameters

origin	Origin of the circle trajectory.
up	Normal vector for the plane where the circle exists. The vector will be normalized internally.
angleInDegrees	Rotation angle of the circle trajectory in its plane, in degrees.
radius	Radius of the circle.
domain	UI domain to use.
name	Node name.

static TrajectorySharedPtr kanzi::Trajectory::createLine	(	Vector3	origin,
		Vector3	direction,
		kzFloat	length,
		kanzi::Domain *	domain,
		string_view	name
	)

static

Creates a line trajectory.

Parameters

origin	Origin of the line.
direction	Direction vector for the line. Direction will be normalized internally.
length	Length of the line.
domain	UI domain to use.
name	Node name.

static TrajectorySharedPtr kanzi::Trajectory::createSpline	(	KzcSpline *	spline,
		kanzi::Domain *	domain,
		string_view	name
	)

static

Creates a spline trajectory.

Parameters

spline Spline structure to use as trajectory.

Vector3 kanzi::Trajectory::getPointAbsolute ( kzFloat lengthParameter ) const

Gets a point on trajectory by using absolute coordinates ranging from 0.0 to trajectory length.

Parameters

lengthParameter Point on the trajectory.

Vector3 kanzi::Trajectory::getPointRelative ( kzFloat phaseParameter ) const

Gets a point on trajectory by using relative coordinates.

Parameters

phaseParameter Point on the trajectory. 0.0f start, 1.0f end.

kzFloat kanzi::Trajectory::getLength ( ) const

Gets length of trajectory.

bool kanzi::Trajectory::isComplete ( ) const

Returns true if trajectory is complete and usable.

const KzcSpline* kanzi::Trajectory::getSpline ( ) const

Returns spline in case of trajectory having the spline.

If type of the trajectory is not spline then NULL be returned.

kzUint kanzi::Trajectory::getVisualizationPointCount ( ) const

Gets the number of counts recommended for visualizing the trajectory.

Vector3 kanzi::Trajectory::getVisualizationPoint	(	kzUint	pointIndex,
		kzUint	pointCount
	)		const

Gets a visualization point of the trajectory.

Type kanzi::Trajectory::getType ( ) const

Return the type of the trajectory.

kzFloat kanzi::Trajectory::getRadius ( ) const

Return radius of a circle trajectory.

kzFloat kanzi::Trajectory::getAngle ( ) const

Return angle of a circle trajectory.

Vector3 kanzi::Trajectory::getLineDirection ( ) const

Return direction vector of a line trajectory.

Vector3 kanzi::Trajectory::getCircleNormal ( ) const

Return normal vector for the plane of a circle trajectory.

Vector3 kanzi::Trajectory::getCircleOrigin ( ) const

Return origin point of a circle trajectory.

Vector3 kanzi::Trajectory::scalePoint	(	Vector3	point,
		const Matrix4x4 &	transform,
		Vector3	scaling
	)		const

virtual void kanzi::Trajectory::loadFromKZB	(	const ResourceLoaderThreadContext *	threadContext,
		KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

Function for loading the resource from .KZB.

This function is called when loading the data from .KZB file. Implementations should call super class loadFromKZB before reading anything else from inputStream. This function is called from arbitrary loading threads. The parameter threadContext contains thread safe memory manager and a thread specific Property manager which can be locked with the threadLock in the threadContext. This function may not access resource manager or the UIDomain due to race conditions.

Reimplemented from kanzi::Resource.

static TrajectorySharedPtr kanzi::Trajectory::loadFromKZB	(	Domain *	domain,
		string_view	name,
		KzbFile &	kzbFile,
		ReadOnlyMemoryFile &	file,
		KzbMemoryParser &	parser
	)

static

Loads a trajectory from a file.

Used internally by Kanzi Engine.

Parameters

domain	Domain
name	Name
kzbFile	KZB file where to load from.
file	Trajectory file inside the KZB file where to load from.
parser	Parser pointing to the beginning of the file.

Member Data Documentation

KzcSpline* kanzi::Trajectory::spline

The spline of the trajectory.

struct { ... } kanzi::Trajectory::spline

kzFloat kanzi::Trajectory::radius

The spline of the trajectory. Radius of the circle.

kzFloat kanzi::Trajectory::angle

The spline of the trajectory. Starting angle of the circle.

KzcMatrix4x4 kanzi::Trajectory::transform

The spline of the trajectory. Circle's transformation from unit circle in XY plane.

struct { ... } kanzi::Trajectory::circle

kzFloat kanzi::Trajectory::length

Length of the line.

KzcVector3 kanzi::Trajectory::origin

Origin of the line.

KzcVector3 kanzi::Trajectory::direction

Normalized direction of the line.

struct { ... } kanzi::Trajectory::line

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

kanzi/core.ui/resource/trajectory.hpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation