CC3PODLight Class Reference
Inherits from | CC3Light : CC3Node : CC3Identifiable : NSObject |
Declared in | CC3PODLight.h CC3PODLight.mm |
Overview
A CC3Light whose content originates from POD resource data.
This is a concrete implementation of the CC3Node category PVRPOD.
Instance Methods
globalHomogeneousPosition
The position of this light in a global 4D homogeneous coordinate space.
- (CC3Vector4)globalHomogeneousPosition
Discussion
The X, Y & Z components of the returned 4D vector are the same as those in the globalLocation property. The W-component will be zero if the isDirectionalOnly property is set to YES, indicating that this position represents a direction. The W-component will be one if the isDirectionalOnly property is set to NO, indicating that this position represents a specific location.
Declared In
CC3Light.h
initAtIndex:fromPODResource:
Initializes this instance from the data of this type at the specified index within the specified POD resource.
- (id)initAtIndex:(GLint)aPODIndex fromPODResource:(CC3PODResource *)aPODRez
Declared In
CC3IdentifiablePODExtensions.h
nodePODStructAtIndex:fromPODResource:
Returns the underlying SPODNode data structure from the specified resource, for the SPODNode at the specified index.
- (PODStructPtr)nodePODStructAtIndex:(uint)aPODIndex fromPODResource:(CC3PODResource *)aPODRez
Discussion
The returned pointer must be cast to SPODNode before accessing any internals of the data structure.
Declared In
CC3NodePODExtensions.h
podContentIndex
The index of the POD data that forms the type-specific content of this node.
- (GLint)podContentIndex
Discussion
This is distinct from the podIndex property, which is the index of the data for the node, which may be of any node type. Once the type is established, the type-specific content is indexed by the podContentIndex property.
This abstract implementation does not map this property to an instance variable, and always returns kCC3PODNilIndex. Concrete subclasses must override to map to an actual instance variable.
Declared In
CC3NodePODExtensions.h
podIndex
The index of this object in the POD resource data. This generally means the podIndex'th type of object of the class.
- (GLint)podIndex
Declared In
CC3IdentifiablePODExtensions.h
podParentIndex
The index of the parent node of this node. This will be -1 if this node has no parent.
- (GLint)podParentIndex
Discussion
This abstract implementation does not map this property to an instance variable, and always returns kCC3PODNilIndex. Concrete subclasses must override to map to an actual instance variable.
Declared In
CC3NodePODExtensions.h
podTargetIndex
The index of the node that is the target of this node. This node will be linked to its target in the linkToPODNodes: method.
- (GLint)podTargetIndex
Discussion
This abstract implementation does not map this property to an instance variable, and always returns kCC3PODNilIndex. Concrete subclasses must override to map to an actual instance variable.
Declared In
CC3NodePODExtensions.h
populateFrom:
Template method that populates this instance from the specified other instance.
- (void)populateFrom:(CC3PODLight *)another
Discussion
This method is invoked automatically during object copying via the copy or copyWithZone: method. In most situations, the application should use the copy method, and should never need to invoke this method directly.
Subclasses that add additional instance state (instance variables) should extend copying by overriding this method to copy that additional state. Superclass that override this method should be sure to invoke the superclass implementation to ensure that superclass state is copied as well.
Declared In
CC3Identifiable.h
setPodContentIndex:
The index of the POD data that forms the type-specific content of this node.
- (void)setPodContentIndex:(GLint)aPODIndex
Discussion
This is distinct from the podIndex property, which is the index of the data for the node, which may be of any node type. Once the type is established, the type-specific content is indexed by the podContentIndex property.
This abstract implementation does not map this property to an instance variable, and always returns kCC3PODNilIndex. Concrete subclasses must override to map to an actual instance variable.
Declared In
CC3NodePODExtensions.h
setPodIndex:
The index of this object in the POD resource data. This generally means the podIndex'th type of object of the class.
- (void)setPodIndex:(GLint)aPODIndex
Declared In
CC3IdentifiablePODExtensions.h
setPodParentIndex:
The index of the parent node of this node. This will be -1 if this node has no parent.
- (void)setPodParentIndex:(GLint)aPODIndex
Discussion
This abstract implementation does not map this property to an instance variable, and always returns kCC3PODNilIndex. Concrete subclasses must override to map to an actual instance variable.
Declared In
CC3NodePODExtensions.h
setPodTargetIndex:
The index of the node that is the target of this node. This node will be linked to its target in the linkToPODNodes: method.
- (void)setPodTargetIndex:(GLint)aPODIndex
Discussion
This abstract implementation does not map this property to an instance variable, and always returns kCC3PODNilIndex. Concrete subclasses must override to map to an actual instance variable.
Declared In
CC3NodePODExtensions.h