update readme and add gitignore
[client-tools.git] / tools / perllib / MeshAppearanceTemplate.pm
blobba63025bb9dd92f6eadfd79dc88a698e37ef19a9
1 # ======================================================================
2 # MeshAppearanceTemplate.pm
3 # Copyright 2003, Sony Online Entertainment
4 # All rights reserved.
5 # ======================================================================
7 package MeshAppearanceTemplate;
8 use strict;
10 use CustomizationVariableCollector;
11 use Iff;
13 # ======================================================================
14 # MeshAppearanceTemplate potentially-public variables.
15 # ======================================================================
17 # our $relativePathName;
19 # ======================================================================
20 # Setup variables that can be imported by Exporter into user modules.
21 # ======================================================================
23 use vars qw(@ISA @EXPORT_OK $VERSION);
24 use Exporter;
25 $VERSION = 1.00;
26 @ISA = qw(Exporter);
28 # These symbols are okay to export if specifically requested.
29 @EXPORT_OK = qw(&install);
31 # ======================================================================
32 # MeshAppearanceTemplate private variables.
33 # ======================================================================
35 my $debug = 0;
36 my $treeFileRelativeName;
38 # ======================================================================
39 # MeshAppearanceTemplate public functions.
40 # ======================================================================
42 sub install
44 # Register handler with CustomizationVariableCollector
45 CustomizationVariableCollector::registerHandler("MESH", \&processIff);
48 # ======================================================================
49 # MeshAppearanceTemplate private functions
50 # ======================================================================
52 sub processIff
54 # Process args.
55 my $iff = shift;
56 die "bad iff arg specified" if ref($iff) ne "Iff";
58 $treeFileRelativeName = shift;
59 die "bad tree file relative name" if !defined($treeFileRelativeName);
60 print "MeshAppearanceTemplate: processing file [$treeFileRelativeName]\n" if $debug;
62 # Ensure we're in the proper form.
63 return 0 unless $iff->getCurrentName() eq "MESH";
65 $iff->enterForm("MESH");
67 my $version = $iff->getCurrentName();
68 if ($version =~ m/^000[2-5]$/)
70 process_0002_0005($iff);
72 else
74 print STDERR "MeshAppearanceTemplate: unsupported version tag [$version].";
75 return 0;
78 $iff->exitForm("MESH");
80 print "MeshAppearanceTemplate: finished processing file [$treeFileRelativeName]\n" if $debug;
82 # Success.
83 return 1;
86 # ----------------------------------------------------------------------
88 sub process_0002_0005
90 print "process_0002_0005(): begin\n" if $debug;
92 my $iff = shift;
93 die 'bad $iff arg' if ref($iff) ne 'Iff';
95 $iff->enterForm();
97 $iff->walkIff(\&iffWalker_0002_0005);
99 $iff->exitForm();
101 print "process_0002_0005(): end\n" if $debug;
104 # ----------------------------------------------------------------------
106 sub iffWalker_0002_0005
108 my $iff = shift;
109 die 'bad iff arg' if ref($iff) ne 'Iff';
111 my $blockName = shift;
112 my $isChunk = shift;
114 printf("iffWalker_0002_0005(): %s=[%s]\n", $isChunk ? "chunk" : "form", $blockName) if $debug;
116 # Process blocks we understand.
117 if ($isChunk)
119 if ($blockName eq 'NAME')
121 # Handle specifying linked shader templates.
122 my $shaderTemplateName = $iff->read_string();
123 CustomizationVariableCollector::logAssetLink($treeFileRelativeName, $shaderTemplateName);
127 # Keep traversing.
128 return 1;
131 # ======================================================================