tools/perllib/CustomizableShaderTemplate.pm

   1 # ======================================================================
   2 # CustomizableShaderTemplate.pm
   3 # Copyright 2003, Sony Online Entertainment
   4 # All rights reserved.
   5 # ======================================================================
   6
   7 package CustomizableShaderTemplate;
   8 use strict;
   9
  10 use CustomizationVariableCollector;
  11 use Iff;
  12
  13 # ======================================================================
  14 # CustomizableShaderTemplate potentially-public variables.
  15 # ======================================================================
  16
  17 # our $relativePathName;
  18
  19 # ======================================================================
  20 # Setup variables that can be imported by Exporter into user modules.
  21 # ======================================================================
  22
  23 use vars qw(@ISA @EXPORT_OK $VERSION);
  24 use Exporter;
  25 $VERSION = 1.00;
  26 @ISA     = qw(Exporter);
  27
  28 # These symbols are okay to export if specifically requested.
  29 @EXPORT_OK = qw(&install);
  30
  31 # ======================================================================
  32 # CustomizableShaderTemplate private variables.
  33 # ======================================================================
  34
  35 my $debug = 0;
  36 my $treeFileRelativeName;
  37
  38 # ======================================================================
  39 # CustomizableShaderTemplate public functions.
  40 # ======================================================================
  41
  42 sub install
  43 {
  44         # Register handler with CustomizationVariableCollector
  45         CustomizationVariableCollector::registerHandler("CSHD", \&processIff);
  46 }
  47
  48 # ======================================================================
  49 # CustomizableShaderTemplate private functions
  50 # ======================================================================
  51
  52 sub processIff
  53 {
  54         # Process args.
  55         my $iff = shift;
  56         die "bad iff arg specified" if ref($iff) ne "Iff";
  57
  58         $treeFileRelativeName = shift;
  59         die "bad tree file relative name" if !defined($treeFileRelativeName);
  60         print "CustomizableShaderTemplate: processing file [$treeFileRelativeName]\n" if $debug;
  61
  62         # Ensure we're in the proper form.
  63         return 0 unless $iff->getCurrentName() eq "CSHD";
  64
  65         $iff->enterForm("CSHD");
  66         {
  67                 my $version = $iff->getCurrentName();
  68                 if ($version eq "0001")
  69                 {
  70                         process_0001($iff);
  71                 }
  72                 else
  73                 {
  74                         print STDERR "CustomizableShaderTemplate: unsupported version tag [$version].";
  75                         return 0;
  76                 }
  77         }
  78         $iff->exitForm("CSHD");
  79
  80         print "CustomizableShaderTemplate: finished processing file [$treeFileRelativeName]\n" if $debug;
  81
  82         # Success.
  83         return 1;
  84 }
  85
  86 # ----------------------------------------------------------------------
  87
  88 sub process_0001
  89 {
  90         print "process_0001(): begin\n" if $debug;
  91
  92         my $iff = shift;
  93         die 'bad $iff arg' if ref($iff) ne 'Iff';
  94
  95         $iff->enterForm("0001");
  96         $iff->walkIff(\&iffWalker_0001);
  97         $iff->exitForm("0001");
  98
  99         print "process_0001(): end\n" if $debug;
 100 }
 101
 102 # ----------------------------------------------------------------------
 103
 104 sub iffWalker_0001
 105 {
 106         my $iff = shift;
 107         die 'bad iff arg' if ref($iff) ne 'Iff';
 108
 109         my $blockName = shift;
 110         my $isChunk       = shift;
 111
 112         printf("iffWalker_0001(): %s=[%s]\n", $isChunk ? "chunk" : "form", $blockName) if $debug;
 113
 114         # Process blocks we understand.
 115         if ($isChunk)
 116         {
 117                 if ($blockName eq 'AMCL')
 118                 {
 119                         # Handle material ambient color.
 120                         my $variableShortName = $iff->read_string();
 121                         my $variableIsPrivate = $iff->read_uint8();
 122                         my $palettePathName       = $iff->read_string();
 123                         my $defaultIndex          = $iff->read_uint32();
 124
 125                         my $variableFullName  = ($variableIsPrivate ? '/private/' : '/shared_owner/') . $variableShortName;
 126                         CustomizationVariableCollector::logPaletteColorVariable($treeFileRelativeName, $variableFullName, $palettePathName, $defaultIndex);
 127                 }
 128                 elsif ($blockName eq 'DFCL')
 129                 {
 130                         # Handle material diffuse color.
 131                         my $variableShortName = $iff->read_string();
 132                         my $variableIsPrivate = $iff->read_uint8();
 133                         my $palettePathName       = $iff->read_string();
 134                         my $defaultIndex          = $iff->read_uint32();
 135
 136                         my $variableFullName  = ($variableIsPrivate ? '/private/' : '/shared_owner/') . $variableShortName;
 137                         CustomizationVariableCollector::logPaletteColorVariable($treeFileRelativeName, $variableFullName, $palettePathName, $defaultIndex);
 138                 }
 139                 elsif ($blockName eq 'EMCL')
 140                 {
 141                         # Handle material emissive color.
 142                         my $variableShortName = $iff->read_string();
 143                         my $variableIsPrivate = $iff->read_uint8();
 144                         my $palettePathName       = $iff->read_string();
 145                         my $defaultIndex          = $iff->read_uint32();
 146
 147                         my $variableFullName  = ($variableIsPrivate ? '/private/' : '/shared_owner/') . $variableShortName;
 148                         CustomizationVariableCollector::logPaletteColorVariable($treeFileRelativeName, $variableFullName, $palettePathName, $defaultIndex);
 149                 }
 150                 elsif ($blockName eq 'PAL ')
 151                 {
 152                         # Handle TextureFactor customization
 153                         my $variableShortName = $iff->read_string();
 154                         my $variableIsPrivate = $iff->read_uint8();
 155                         $iff->skipBytes(4);
 156                         my $palettePathName       = $iff->read_string();
 157                         my $defaultIndex          = $iff->read_uint32();
 158
 159                         my $variableFullName  = ($variableIsPrivate ? '/private/' : '/shared_owner/') . $variableShortName;
 160                         CustomizationVariableCollector::logPaletteColorVariable($treeFileRelativeName, $variableFullName, $palettePathName, $defaultIndex);
 161                 }
 162
 163                 elsif ($blockName eq 'TX1D')
 164                 {
 165                         $iff->skipBytes(6);
 166                         my $rangeMaxExclusive = $iff->read_uint16();
 167                         my $variableShortName = $iff->read_string();
 168                         my $variableIsPrivate = $iff->read_uint8();
 169                         my $defaultValue          = $iff->read_uint16();
 170
 171                         my $rangeMinInclusive = 0;
 172                         my $variableFullName  = ($variableIsPrivate ? '/private/' : '/shared_owner/') . $variableShortName;
 173                         CustomizationVariableCollector::logBasicRangedIntVariable($treeFileRelativeName, $variableFullName, $rangeMinInclusive, $rangeMaxExclusive, $defaultValue);
 174                 }
 175         }
 176
 177         # Keep traversing.
 178         return 1;
 179 }
 180
 181 # ======================================================================
 182
 183 1;