Kanzi  3.9.4
Java API
PrefabTemplate Class Reference

This class represents a prefab (prefabricated template) resource that is a description of a scene graph that can be instantiated at runtime. More...

Inheritance diagram for PrefabTemplate:
[legend]

Public Member Functions

ObjectRef< TNodeType > instantiate (String name)
 Instantiate the prefab with a given name. More...
 
- Public Member Functions inherited from Resource
String getName ()
 Gets the resource name. More...
 
String getUrl ()
 Gets the resource URL. More...
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
TDataType getOptionalProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
EnumType getProperty (PropertyType< Integer > propertyType, Class< EnumType > enumClass)
 Returns the current value of an integer property type converted to a matching constant from specified enumeration. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
void setProperty (PropertyType< Integer > propertyType, EnumType value)
 Sets the local value of an integer property type using a constant from an enumeration. More...
 

Static Public Attributes

static final Metaclass metaclass = new AbstractMetaclass("Kanzi.PrefabTemplate")
 The Metaclass for the class.
 
- Static Public Attributes inherited from Resource
static final Metaclass metaclass = com.rightware.kanzi.metadata.ResourceMetadata.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from KanziObject
static final Metaclass metaclass = new AbstractMetaclass("Kanzi.Object")
 The Metaclass for the class.
 

Additional Inherited Members

- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 

Detailed Description

This class represents a prefab (prefabricated template) resource that is a description of a scene graph that can be instantiated at runtime.

It is possible to instantiate the same prefab multiple times to create multiple instances of it.

Use prefabs to structure your application and to create consistent interfaces. Prefabs allow you to create the building blocks of your application and make the application easier to maintain.

Create a prefab for every item in your application that appears more than once, when you want to logically separate a part of your application, or add content to the scene graph when your application is already running.

Member Function Documentation

◆ instantiate()

ObjectRef<TNodeType> instantiate ( String  name)

Instantiate the prefab with a given name.

Parameters
nameName of the root node.
<TNodeType>Expected type of the node, optional.
Returns
Root node of the instantiated prefab.