#include <kanzi/resource/trajectory.hpp>

Inheritance diagram for kanzi::Trajectory:

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

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...

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

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

void	loadFromKZB (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

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

virtual void	finishLoadingOverride (const KzuResourceLoaderThreadContext *threadContext)
	Function for finishing the loading of the resource. More...

virtual void	unloadOverride ()
	Unload function for resource. More...

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

void	setKZB (const KzuBinaryDirectory *binaryDirectory, kzString path)

void	setLoaded ()

kzString	getName () const
	Accessor. More...

void	load ()

void	unload ()

bool	isLoaded () const

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

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

KzuResourceLoadingStrategy	getLoadingStrategy () const

void	setLoadingStrategy (KzuResourceLoadingStrategy loadingStrategy)

bool	getKeepAlive () 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...

KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. 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
	Returns the metaclass of the dynamic type of the object. More...

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

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

void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...

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

template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)

void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const

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

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

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

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

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

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

void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)

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

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. 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 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...

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

Protected Member Functions inherited from kanzi::Resource
KzuResourceLoadState	getLoadState ()
	Access. More...

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

void	onCopy (const Object &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.
angle	Rotation angle of the circle trajectory in its plane, in degrees.
radius	Radius of the circle.

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.

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.

Vector3 kanzi::Trajectory::getLineDirection ( ) const

Return direction vector of a line trajectory.

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

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

Member Data Documentation

KzcSpline* kanzi::Trajectory::spline

The spline of the trajectory.

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

kzFloat kanzi::Trajectory::radius

Radius of the circle.

KzcMatrix4x4 kanzi::Trajectory::transform

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/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