iPropertySeqOpFactory Struct Reference

This interface is implemented by the seqop that transforms property class properties. More...

#include <tools/sequences.h>

Inheritance diagram for iPropertySeqOpFactory:

List of all members.

Public Member Functions
virtual void	SetEntityParameter (const char *entity)=0
	Set the entity containing the property (either entity name or a parameter if it starts with '$').
virtual void	SetFloatParameter (const char *pfloat)=0
	Set the end value for the property as a float.
virtual void	SetLongParameter (const char *plong)=0
	Set the end value for the property as a long.
virtual void	SetPCParameter (const char *pc, const char *tag=0)=0
	Set the property class and tag to search for.
virtual void	SetPropertyParameter (const char *property_name)=0
	Set the property name for this sequence.
virtual void	SetRelative (bool is_relative)=0
	Set whether the sequence will be relative: (end value = specified value + starting value) or absolute.
virtual void	SetVector2Parameter (const char *vectorx, const char *vectory)=0
	Set the end value for the property as a vector2.
virtual void	SetVector3Parameter (const char *vectorx, const char *vectory, const char *vectorz)=0
	Set the end value for the property as a vector3.

---

Detailed Description

This interface is implemented by the seqop that transforms property class properties.

Assuming it is read and write, and of the appropriate type any property can be controlled using this sequence.

You can query this interface from the seqop factory if you want to manually control this factory as opposed to loading its definition from an XML document.

The predefined name of this seqop type is 'cel.seqops.property'.

In XML, factories recognize the following attributes on the 'op' node:

• entity: the name of the entity containing the affected property class.
• pc: name for the property class holding the property.
• tag: optional tag used to find the right property class from the entity.
• relative: whether the sequence is relative (default false).
• float: optional end value as a float.
• long: optional end value as an integer. And the following sub nodes:
• v: optional end value as a vector. This node has 'x', 'y, and (optionally for vector3) 'z' attributes.

Note you must only provide one of 'v', 'float' and 'long' parameters to the sequence, otherwise the result will be undefined. Also, the parameter must fit the actual property type.

Definition at line 374 of file sequences.h.

---

Member Function Documentation

virtual void iPropertySeqOpFactory::SetEntityParameter

(

const char *

entity

)

[pure virtual]

Set the entity containing the property (either entity name or a parameter if it starts with '$').

virtual void iPropertySeqOpFactory::SetFloatParameter

(

const char *

pfloat

)

[pure virtual]

Set the end value for the property as a float.

Parameters:

pfloat

is the value to be set. It can also be a parameter if it starts with '$'.

virtual void iPropertySeqOpFactory::SetLongParameter

(

const char *

plong

)

[pure virtual]

Set the end value for the property as a long.

Parameters:

plong

is the value to be set. It can also be a parameter if it starts with '$'.

virtual void iPropertySeqOpFactory::SetPCParameter	(	const char *	pc,
		const char *	tag = 0
	)		[pure virtual]

Set the property class and tag to search for.

Parameters:

pc	is the property class name or a parameter (starts with a '$').
tag	is the optional tag of the entity or a parameter (starts with '$').

virtual void iPropertySeqOpFactory::SetPropertyParameter

(

const char *

property_name

)

[pure virtual]

Set the property name for this sequence.

Parameters:

property_name

is the property name (like cel.property.gravity). It can also be a parameter if it starts with '$'.

virtual void iPropertySeqOpFactory::SetRelative

(

bool

is_relative

)

[pure virtual]

Set whether the sequence will be relative: (end value = specified value + starting value) or absolute.

(end value = specified value)

Parameters:

is_relative

whether the sequence is relative. can't be a parameter.

virtual void iPropertySeqOpFactory::SetVector2Parameter	(	const char *	vectorx,
		const char *	vectory
	)		[pure virtual]

Set the end value for the property as a vector2.

Parameters:

pvectorx	is the x component for the vector.
pvectory	is the y component for the vector. Both pvectorx and pvectory can be parameters if they start with '$'.

virtual void iPropertySeqOpFactory::SetVector3Parameter	(	const char *	vectorx,
		const char *	vectory,
		const char *	vectorz
	)		[pure virtual]

Set the end value for the property as a vector3.

Parameters:

pvectorx	is the x component for the vector.
pvectory	is the y component for the vector.
pvectorz	is the z component for the vector. Both pvectorx, pvectory and pvectorz can be a parameters if they start with '$'.

---

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

• tools/sequences.h