com.lhkbob.entreri.property

Interface PropertyFactory<T extends Property>

Type Parameters:

T - The Property type created

All Known Implementing Classes:

BooleanProperty.Factory, ByteProperty.Factory, CharProperty.Factory, DoubleProperty.Factory, FloatProperty.Factory, IntProperty.Factory, LongProperty.Factory, ObjectProperty.Factory, ShortProperty.Factory

public interface PropertyFactory<T extends Property>

A PropertyFactory is a simple factory that can be used to create Property instances. Additionally, it is used when decorating a ComponentData type in an EntitySystem to ensure that each decoration event gets a unique property instance.

PropertyFactory implementations must have a no-argument constructor or a constructor that takes an Attributes as its only argument. The constructor does not need to be public.

Author:

Michael Ludwig

Method Summary

Methods

Modifier and Type	Method and Description
void	clone(T src, int srcIndex, T dst, int dstIndex) Copy the value from src at component index, srcIndex to dst at dstIndex.
T	create() Return a new Property instance.
void	setDefaultValue(T property, int index) Set the default value that the component at the specified index will see before it's init() method is invoked.

Method Detail

create

T create()

Return a new Property instance. This must be a new instance that has not been returned previously or the entity framework will have undefined behavior.

Returns:

A new Property of type T

setDefaultValue

void setDefaultValue(T property,
                   int index)

Set the default value that the component at the specified index will see before it's init() method is invoked. In some cases, this could be used in-place of initializing in init() method.

Parameters:

property - The property whose value will be updated

index - The component index to be updated

clone

void clone(T src,
         int srcIndex,
         T dst,
         int dstIndex)

Copy the value from src at component index, srcIndex to dst at dstIndex. This is used when a component is created and cloned from a template with Entity.add(com.lhkbob.entreri.Component). For many cases a plain copy-by-value or copy-by-reference is sufficient, but some component types might require more complicated cloning rules.

Parameters:

src - The source property that is being cloned

srcIndex - The index into src of the component being cloned

dst - The destination property created from the template

dstIndex - The index into dst of the component being created