Public Member Functions | Static Public Member Functions | Properties

CC3PODResourceNode Class Reference

A CC3Node that that wraps a CC3PODResource PVR POD resource, extracts the nodes from that resource, and forms the root of the resulting node structural assembly. More...

#import <CC3PODResourceNode.h>

Inheritance diagram for CC3PODResourceNode:
CC3Node CC3Identifiable

List of all members.

Public Member Functions

(id) - initFromPODFile:
(id) - initFromPODResourceFile:
(void) - loadFromPODFile:
(void) - loadFromPODResourceFile:

Static Public Member Functions

(id) + nodeFromPODFile:
(id) + nodeFromPODResourceFile:

Properties

CC3PODResourceresource

Detailed Description

Once created and loaded, this node can simply be added to a CC3World as a child node. Since the node structural assembly is hierarchical, adding this node to the CC3World will automatically add all the nodes extracted from the POD file.


Member Function Documentation

- (id) initFromPODFile: (NSString *)  aFilepath

Initializes this instance, loads the POD file at the specified path, extracts the assembled and configured nodes from the file, and adds them as child nodes to this instance.

The specified file path must be an absolute path.

- (id) initFromPODResourceFile: (NSString *)  aRezPath

Initializes this instance, loads the POD file at the specified resource path, extracts the assembled and configured nodes from the file, and adds them as child nodes to this instance.

The specified file path is a path relative to the resource directory. Typically this means that the specified path can just be the name of the file, with no path information.

- (void) loadFromPODFile: (NSString *)  aFilepath

Loads the POD file at the specified path, extracts the assembled and configured nodes from the file, and adds them as child nodes to this instance.

Any existing child nodes of this instance are removed.

The specified file path must be an absolute path.

- (void) loadFromPODResourceFile: (NSString *)  aRezPath

Loads the POD file at the specified resource path, extracts the assembled and configured nodes from the file, and adds them as child nodes to this instance.

Any existing child nodes of this instance are removed.

The specified file path is a path relative to the resource directory. Typically this means that the specified path can just be the name of the file, with no path information.

+ (id) nodeFromPODFile: (NSString *)  aFilepath

Allocates and initializes an autoreleased instance, loads the POD file at the specified path, extracts the assembled and configured nodes from the file, and adds them as child nodes to this instance.

The specified file path must be an absolute path.

+ (id) nodeFromPODResourceFile: (NSString *)  aRezPath

Allocates and initializes an autoreleased instance, loads the POD file at the specified resource path, extracts the assembled and configured nodes from the file, and adds them as child nodes to this instance.

The specified file path is a path relative to the resource directory. Typically this means that the specified path can just be the name of the file, with no path information.


Property Documentation

- (CC3PODResource *) resource [read, write, retain]

The underlying CC3PODResource POD resource object.

Setting this property will remove all child nodes of this CC3PODResourceNode and replace them with the nodes extracted from the nodes property of the new CC3PODResource.


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