ImporterObject (object)

The ImporterObject is the based class for all specialized objects inside of the GenericImporter extension. The ImporterObject stores an arbitrary list of a generic value, called the ImporterProperty. Specialized implementations such as the ImporterLight, for example, are then used to define a schema on top of the completely generic ImporterObject. The ImporterObject also provides access to meta data, animation data and can be used to get access to ImporterProperty values in a delayed fashion.

ImporterObject ImporterObject ImporterObject ImporterObject_Virtuals ImporterObject_Virtuals ImporterObject->ImporterObject_Virtuals ImporterAnimCurve ImporterAnimCurve ImporterAnimCurve->ImporterObject ImporterMaterial ImporterMaterial ImporterMaterial->ImporterObject ImporterTexture ImporterTexture ImporterTexture->ImporterObject ImporterTransform ImporterTransform ImporterTransform->ImporterObject ImporterCamera ImporterCamera ImporterCamera->ImporterTransform ImporterGroup ImporterGroup ImporterGroup->ImporterTransform ImporterLayer ImporterLayer ImporterLayer->ImporterGroup ImporterInstance ImporterInstance ImporterInstance->ImporterTransform ImporterLight ImporterLight ImporterLight->ImporterTransform ImporterShape ImporterShape ImporterShape->ImporterTransform

Members

Importer importer  
ImporterCallback callback  
String id  
UInt32 version  
Ref<ImporterObject> parentObject  
String path  
String type  
String[] curves  
ImporterProperty[String] properties  
ImporterProperty[String] propertyCaches  
Boolean[String] propertyConstant  
ImporterObjectMetaData metaData  
ImporterContext defaultContext  
ImporterObjectContexts lastContextsPerProperty  

Methods

  ImporterObject ( in ImporterObject other )
  ImporterObject ( in String id, in String path, in String type )
  ImporterObject ()
ImporterObject clone ? ()
  cloneAllProperties ! ()
  cloneMembersTo ? ( io ImporterObject other )
  cloneProperty ! ( in String key )
Boolean dirtyProperty ! ( in String propertyName )
Ref<ImporterObject> getAnimCurve ? ( in UInt32 index )
Ref<ImporterObject> getAnimCurveByName ? ( in String name )
UInt32 getAnimCurveCount ? ()
String getAnimCurveID ? ( in UInt32 index )
String[] getAnimCurvePaths ? ()
Ref<ImporterObject>[] getAnimCurves ? ()
Boolean getBooleanProperty ? ( in String key )
Box3 getBox3Property ? ( in String key )
Color getColor ? ( in ImporterContext context )
Color getColorProperty ? ( in String key )
Geometry getGeometryProperty ? ( in String key )
String getID ? ()
String getInstancePath ? ()
Integer getIntegerProperty ? ( in String key )
KeyframeTrack getKeyframeTrackProperty ? ( in String key )
Ref<ImporterObject> getLayer ? ( in ImporterContext context )
String getLayerID ? ( in ImporterContext context )
Mat44 getMat44Property ? ( in String key )
String getMetaData ? ( in String key )
String getMetaData ? ( in String key, in String defaultValue )
String[] getMetaDataKeys ? ()
String getName ? ()
Ref<ImporterObject> getOrCreateCloneForPath ? ( in String path )
Ref<ImporterObject> getParent ? ()
String getParentPath ? ()
String getPath ? ()
ImporterProperty getProperty ? ( in String key )
String[] getPropertyNames ? ()
String getPropertyType ? ( in String key )
Quat getQuatProperty ? ( in String key )
Scalar[] getScalarArrayProperty ? ( in String key )
Scalar getScalarProperty ? ( in String key )
String[] getStringArrayProperty ? ( in String key )
String getStringProperty ? ( in String key )
Vec2 getTimeRange ? ( in ImporterContext context )
Float32[] getTimeSamples ? ( in ImporterContext context )
String getType ? ()
Vec2 getVec2Property ? ( in String key )
Vec3 getVec3Property ? ( in String key )
UInt32 getVersion ? ()
Boolean getVisible ? ( in ImporterContext context )
Xfo getXfoProperty ? ( in String key )
Boolean hasMetaData ? ( in String key )
Boolean hasProperty ? ( in String key )
  initProperty ! ( in String key, in ImporterProperty prop )
  initialize ! ( in String id, in String path, in String type )
Boolean isConstant ? ( in ImporterContext context )
Boolean isPropertyConstant ? ( in String propertyName )
Color modifyProperty ! ( in SInt32 mode, in String propertyName, in Color value )
Integer modifyProperty ! ( in SInt32 mode, in String propertyName, in Integer value )
Mat44 modifyProperty ! ( in SInt32 mode, in String propertyName, in Mat44 value )
Quat modifyProperty ! ( in SInt32 mode, in String propertyName, in Quat value )
Scalar modifyProperty ! ( in SInt32 mode, in String propertyName, in Scalar value )
Vec2 modifyProperty ! ( in SInt32 mode, in String propertyName, in Vec2 value )
Vec3 modifyProperty ! ( in SInt32 mode, in String propertyName, in Vec3 value )
Xfo modifyProperty ! ( in SInt32 mode, in String propertyName, in Xfo value )
  setColor ! ( in Color color )
  setDefaultContext ! ( in ImporterContext context )
  setLayer ! ( in Ref<ImporterObject> layer )
  setLayerID ! ( in String id )
  setMetaData ! ( in String key, in String value )
  setProperty ! ( in String key, in Boolean value )
  setProperty ! ( in String key, in Box3 value )
  setProperty ! ( in String key, in Color value )
  setProperty ! ( in String key, in Geometry value )
  setProperty ! ( in String key, in Integer value )
  setProperty ! ( in String key, in KeyframeTrack value )
  setProperty ! ( in String key, in Mat44 value )
  setProperty ! ( in String key, in Quat value )
  setProperty ! ( in String key, in Scalar value )
  setProperty ! ( in String key, in Scalar value[] )
  setProperty ! ( in String key, in String value )
  setProperty ! ( in String key, in String value[] )
  setProperty ! ( in String key, in Vec2 value )
  setProperty ! ( in String key, in Vec3 value )
  setProperty ! ( in String key, in Xfo value )
  setPropertyConstant ! ( in String propertyName, in Boolean constant )
  setPropertyVarying ! ( in String propertyName )
  setVisible ! ( in Boolean visible )
  setupPropertyCache ! ( in String propertyName )
Boolean updateProperty ! ( in String propertyName, in ImporterContext context )

Methods in detail

ImporterObject ( in ImporterObject other )

copy constructor

ImporterObject ( in String id, in String path, in String type )

ImporterObject ()

default constructor

ImporterObject ImporterObject.clone? ()

clone method

ImporterObject.cloneAllProperties! ()

Clones all properties. See cloneProperty for more details

ImporterObject.cloneMembersTo? ( io ImporterObject other )

ImporterObject.cloneProperty! ( in String key )

Clones a given property. This is useful if the ImporterObject was cloned before. Only certain properties might be cloned, while others might be shared between the ImporterObject clones.

Boolean ImporterObject.dirtyProperty! ( in String propertyName )

Dirties the given property. This ensures the property is reloaded in case it is using a callback. The property is only dirties for the given context

Ref<ImporterObject> ImporterObject.getAnimCurve? ( in UInt32 index )

Ref<ImporterObject> ImporterObject.getAnimCurveByName? ( in String name )

UInt32 ImporterObject.getAnimCurveCount? ()

String ImporterObject.getAnimCurveID? ( in UInt32 index )

String[] ImporterObject.getAnimCurvePaths? ()

Ref<ImporterObject>[] ImporterObject.getAnimCurves? ()

Returns all animation curve objects of this object.

Boolean ImporterObject.getBooleanProperty? ( in String key )

Returns the value of a Boolean property.

Box3 ImporterObject.getBox3Property? ( in String key )

Returns the value of a Box3 property.

Color ImporterObject.getColor? ( in ImporterContext context )

Color ImporterObject.getColorProperty? ( in String key )

Returns the value of a Color property.

Geometry ImporterObject.getGeometryProperty? ( in String key )

Returns the value of a Geometry property.

String ImporterObject.getID? ()

Returns the unique ID of the ImporterObject within the import.

String ImporterObject.getInstancePath? ()

Returns the path of the ImporterObject within the import, but per instance. This path will be only different from the normal path once the object has been traversed. Paths are separated by the forward slash by default.

Integer ImporterObject.getIntegerProperty? ( in String key )

Returns the value of a Integer property.

KeyframeTrack ImporterObject.getKeyframeTrackProperty? ( in String key )

Returns the value of a KeyframeTrack property.

Ref<ImporterObject> ImporterObject.getLayer? ( in ImporterContext context )

String ImporterObject.getLayerID? ( in ImporterContext context )

Mat44 ImporterObject.getMat44Property? ( in String key )

Returns the value of a Mat44 property.

String ImporterObject.getMetaData? ( in String key )

Returns a metadata string for this object or an empty string.

String ImporterObject.getMetaData? ( in String key, in String defaultValue )

Returns a metadata string for this object.

String[] ImporterObject.getMetaDataKeys? ()

Returns all valid keys for metadata on this object.

String ImporterObject.getName? ()

Returns the name of the ImporterObject. The name is the last segment of the path.

Ref<ImporterObject> ImporterObject.getOrCreateCloneForPath? ( in String path )

Ref<ImporterObject> ImporterObject.getParent? ()

Returns the parent of this ImporterObject as defined by the object’s path - or null if there is no parent.

String ImporterObject.getParentPath? ()

String ImporterObject.getPath? ()

Returns the path of the ImporterObject within the import. Paths are separated by the forward slash by default.

ImporterProperty ImporterObject.getProperty? ( in String key )

Returns the generic value of a given property

String[] ImporterObject.getPropertyNames? ()

Returns all valid property names of this object.

String ImporterObject.getPropertyType? ( in String key )

Returns the value type of a given property

Quat ImporterObject.getQuatProperty? ( in String key )

Returns the value of a Quat property.

Scalar[] ImporterObject.getScalarArrayProperty? ( in String key )

Returns the value of a Scalar[] property.

Scalar ImporterObject.getScalarProperty? ( in String key )

Returns the value of a Scalar property.

String[] ImporterObject.getStringArrayProperty? ( in String key )

Returns the value of a String[] property.

String ImporterObject.getStringProperty? ( in String key )

Returns the value of a String property.

Vec2 ImporterObject.getTimeRange? ( in ImporterContext context )

Returns the time range of this object’s animation

Float32[] ImporterObject.getTimeSamples? ( in ImporterContext context )

Returns all sample times of this object’s animation

String ImporterObject.getType? ()

Returns the type of the ImporterObject

Vec2 ImporterObject.getVec2Property? ( in String key )

Returns the value of a Vec2 property.

Vec3 ImporterObject.getVec3Property? ( in String key )

Returns the value of a Vec3 property.

UInt32 ImporterObject.getVersion? ()

Returns the version of this importer object.

Boolean ImporterObject.getVisible? ( in ImporterContext context )

Xfo ImporterObject.getXfoProperty? ( in String key )

Returns the value of a Xfo property.

Boolean ImporterObject.hasMetaData? ( in String key )

Returns true if this object has a given metadata string.

Boolean ImporterObject.hasProperty? ( in String key )

Returns true if this object has a given property.

ImporterObject.initProperty! ( in String key, in ImporterProperty prop )

Defines a new property and sets its value.

ImporterObject.initialize! ( in String id, in String path, in String type )

Boolean ImporterObject.isConstant? ( in ImporterContext context )

Returns true if this object has no animation.

Boolean ImporterObject.isPropertyConstant? ( in String propertyName )

Returns true if a property is constant

Color ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Color value )

Modifies the Color value of a property.

Integer ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Integer value )

Modifies the Integer value of a property.

Mat44 ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Mat44 value )

Modifies the Mat44 value of a property.

Quat ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Quat value )

Modifies the Quat value of a property.

Scalar ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Scalar value )

Modifies the Scalar value of a property.

Vec2 ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Vec2 value )

Modifies the Vec2 value of a property.

Vec3 ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Vec3 value )

Modifies the Vec3 value of a property.

Xfo ImporterObject.modifyProperty! ( in SInt32 mode, in String propertyName, in Xfo value )

Modifies the Xfo value of a property.

ImporterObject.setColor! ( in Color color )

ImporterObject.setDefaultContext! ( in ImporterContext context )

Sets the default context to be used for any property getter. This might be used to drive the time at which to query a property later, for example.

ImporterObject.setLayer! ( in Ref<ImporterObject> layer )

ImporterObject.setLayerID! ( in String id )

ImporterObject.setMetaData! ( in String key, in String value )

Sets a metadata string on this object.

ImporterObject.setProperty! ( in String key, in Boolean value )

Sets the Boolean value of a property.

ImporterObject.setProperty! ( in String key, in Box3 value )

Sets the Box3 value of a property.

ImporterObject.setProperty! ( in String key, in Color value )

Sets the Color value of a property.

ImporterObject.setProperty! ( in String key, in Geometry value )

Sets the Geometry value of a property.

ImporterObject.setProperty! ( in String key, in Integer value )

Sets the Integer value of a property.

ImporterObject.setProperty! ( in String key, in KeyframeTrack value )

Sets the KeyframeTrack value of a property.

ImporterObject.setProperty! ( in String key, in Mat44 value )

Sets the Mat44 value of a property.

ImporterObject.setProperty! ( in String key, in Quat value )

Sets the Quat value of a property.

ImporterObject.setProperty! ( in String key, in Scalar value )

Sets the Scalar value of a property.

ImporterObject.setProperty! ( in String key, in Scalar value[] )

Sets the Scalar[] value of a property.

ImporterObject.setProperty! ( in String key, in String value )

Sets the String value of a property.

ImporterObject.setProperty! ( in String key, in String value[] )

Sets the String[] value of a property.

ImporterObject.setProperty! ( in String key, in Vec2 value )

Sets the Vec2 value of a property.

ImporterObject.setProperty! ( in String key, in Vec3 value )

Sets the Vec3 value of a property.

ImporterObject.setProperty! ( in String key, in Xfo value )

Sets the Xfo value of a property.

ImporterObject.setPropertyConstant! ( in String propertyName, in Boolean constant )

Marks a property as constant or varying

ImporterObject.setPropertyVarying! ( in String propertyName )

Marks a property as varying

ImporterObject.setVisible! ( in Boolean visible )

ImporterObject.setupPropertyCache! ( in String propertyName )

Sets up a cache for all properties. This is useful if you want to modify the properties later on.

Boolean ImporterObject.updateProperty! ( in String propertyName, in ImporterContext context )

Updates the given property is required. The ImporterObject uses an internal cache based on the provided ImporterContext - so the property will only be re-evaluated if the context changes.