Skip to content

Commit

Permalink
hoa.optim~ doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
@eliottparis
eliottparis committed Jun 30, 2015
1 parent 8377163 commit 7876c20
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 39 deletions.
6 changes: 3 additions & 3 deletions Max2D/hoa.2d.optim_tilde.cpp
View file
Expand Up @@ -23,7 +23,7 @@
@category 2d, Ambisonics, MSP
@seealso hoa.2d.decoder~, hoa.2d.map~, hoa.2d.scope~, hoa.2d.meter~, hoa.2d.wider~
@seealso hoa.3d.optim~, hoa.2d.decoder~, hoa.2d.map~, hoa.2d.scope~, hoa.2d.meter~, hoa.2d.wider~
*/

#include "Hoa2D.max.h"
Expand Down Expand Up @@ -159,7 +159,7 @@ void *hoa_optim_new(t_symbol *s, long argc, t_atom *argv)
// @description First argument is the ambisonic order of decomposition.

// @arg 1 @name optimization-mode @optional 1 @type symbol @digest The optimization mode.
// @description The optimization mode can be <b>basic</b> for no optimization (default), <b>maxRe</b> or <b>inPhase</b>.
// @description The optimization mode can be <b>basic</b> for no optimization, <b>maxRe</b> or <b>inPhase</b> (default).

t_hoa_optim *x = NULL;
x = (t_hoa_optim *)object_alloc(hoa_optim_class);
Expand Down Expand Up @@ -211,7 +211,7 @@ void ext_main(void *r)
class_addmethod(c, (method)hoa_optim_assist, "assist", A_CANT, 0);

// @method basic @digest Set the optimization mode to <b>basic</b>, does not apply any optimization.
// @description Set the optimization mode to <b>basic</b>. This is particulary suitable when the listener is ideally placed at the center of the loudspeaker arrangement, or for diffused soundfields.
// @description Set the optimization mode to <b>basic</b>. This is particulary suitable when the listener is ideally placed at the center of the loudspeaker arrangement, or for diffuse soundfields.
class_addmethod(c, (method)hoa_optim_basic, "basic", A_NOTHING, 0);

// @method maxRe @digest Set the optimization mode to <b>maxRe</b>.
Expand Down
4 changes: 2 additions & 2 deletions Max3D/hoa.3d.optim_tilde.cpp
View file
Expand Up @@ -158,7 +158,7 @@ void *hoa_3d_optim_new(t_symbol *s, long argc, t_atom *argv)
// @description First argument is the ambisonic order of decomposition.

// @arg 1 @name optimization-mode @optional 1 @type symbol @digest The optimization mode.
// @description The optimization mode can be <b>basic</b> for no optimization (default), <b>maxRe</b> or <b>inPhase</b>.
// @description The optimization mode can be <b>basic</b> for no optimization, <b>maxRe</b> or <b>inPhase</b> (default).

t_hoa_3d_optim *x = (t_hoa_3d_optim *)object_alloc(hoa_3d_optim_class);
if (x)
Expand Down Expand Up @@ -208,7 +208,7 @@ void ext_main(void *r)
class_addmethod(c, (method)hoa_3d_optim_assist, "assist", A_CANT, 0);

// @method basic @digest Set the optimization mode to <b>basic</b>, does not apply any optimization.
// @description Set the optimization mode to <b>basic</b>. This is particulary suitable when the listener is ideally placed at the center of the loudspeaker arrangement, or for diffused soundfields.
// @description Set the optimization mode to <b>basic</b>. This is particulary suitable when the listener is ideally placed at the center of the loudspeaker arrangement, or for diffuse soundfields.
class_addmethod(c, (method)hoa_3d_optim_basic, "basic", A_NOTHING, 0);

// @method maxRe @digest Set the optimization mode to <b>maxRe</b>.
Expand Down
2 changes: 1 addition & 1 deletion Package/HoaLibrary/docs/refpages/hoa-ref/hoa.2d.optim~.maxref.xml
View file
Expand Up @@ -36,7 +36,7 @@
The optimization mode.
</digest>
<description>
The optimization mode can be <b>basic</b> for no optimization (default), <b>maxRe</b> or <b>inPhase</b>.
The optimization mode can be <b>basic</b> for no optimization, <b>maxRe</b> or <b>inPhase</b> (default).
</description>
</objarg>
</objarglist>
Expand Down
2 changes: 1 addition & 1 deletion Package/HoaLibrary/docs/refpages/hoa-ref/hoa.3d.optim~.maxref.xml
View file
Expand Up @@ -36,7 +36,7 @@
The optimization mode.
</digest>
<description>
The optimization mode can be <b>basic</b> for no optimization (default), <b>maxRe</b> or <b>inPhase</b>.
The optimization mode can be <b>basic</b> for no optimization, <b>maxRe</b> or <b>inPhase</b> (default).
</description>
</objarg>
</objarglist>
Expand Down
4 changes: 0 additions & 4 deletions Package/HoaLibrary/docs/refpages/hoa-ref/hoa.connect.maxref.xml
View file
Expand Up @@ -61,7 +61,6 @@
</description>
<attributelist>
<attribute name="label" get="1" set="1" type="symbol" size="1" value="negative harmonics color" />
<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
<attribute name="style" get="1" set="1" type="symbol" size="1" value="rgba" />
</attributelist>
</attribute>
Expand All @@ -74,7 +73,6 @@
</description>
<attributelist>
<attribute name="label" get="1" set="1" type="symbol" size="1" value="positive harmonics color" />
<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
<attribute name="style" get="1" set="1" type="symbol" size="1" value="rgba" />
</attributelist>
</attribute>
Expand All @@ -87,7 +85,6 @@
</description>
<attributelist>
<attribute name="label" get="1" set="1" type="symbol" size="1" value="planewaves signals color" />
<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
<attribute name="style" get="1" set="1" type="symbol" size="1" value="rgba" />
</attributelist>
</attribute>
Expand All @@ -100,7 +97,6 @@
</description>
<attributelist>
<attribute name="label" get="1" set="1" type="symbol" size="1" value="zero harmonics color" />
<attribute name="save" get="1" set="1" type="int" size="1" value="1" />
<attribute name="style" get="1" set="1" type="symbol" size="1" value="rgba" />
</attributelist>
</attribute>
Expand Down
80 changes: 52 additions & 28 deletions Package/HoaLibrary/help/Hoa2d/hoa.2d.optim~.maxhelp
View file
Expand Up @@ -4,7 +4,7 @@
"appversion" : {
"major" : 7,
"minor" : 0,
"revision" : 3,
"revision" : 4,
"architecture" : "x64",
"modernui" : 1
}
Expand Down Expand Up @@ -55,7 +55,7 @@
"appversion" : {
"major" : 7,
"minor" : 0,
"revision" : 3,
"revision" : 4,
"architecture" : "x64",
"modernui" : 1
}
Expand Down Expand Up @@ -90,6 +90,40 @@
"subpatcher_template" : "",
"showontab" : 1,
"boxes" : [ {
"box" : {
"fontname" : "Arial",
"fontsize" : 12.0,
"id" : "obj-22",
"maxclass" : "comment",
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 413.0, 249.0, 20.0 ],
"style" : "",
"text" : "basic has no effect.",
"textcolor" : [ 0.30292, 0.30292, 0.30292, 1.0 ],
"varname" : "autohelp_top_description[6]"
}

}
, {
"box" : {
"angle" : 0.0,
"bgcolor" : [ 0.94324, 0.954082, 0.954082, 1.0 ],
"border" : 1,
"bordercolor" : [ 0.75, 0.75, 0.75, 1.0 ],
"id" : "obj-24",
"maxclass" : "panel",
"mode" : 0,
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 413.0, 249.0, 20.0 ],
"proportion" : 0.39,
"rounded" : 0,
"style" : ""
}

}
, {
"box" : {
"fontname" : "Arial",
"fontsize" : 12.0,
Expand All @@ -98,7 +132,7 @@
"maxclass" : "comment",
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 338.0, 249.0, 33.0 ],
"patching_rect" : [ 287.0, 342.0, 249.0, 33.0 ],
"style" : "",
"text" : "if no optimization-mode is specified, the optimization will be inPhase.",
"textcolor" : [ 0.30292, 0.30292, 0.30292, 1.0 ],
Expand All @@ -117,7 +151,7 @@
"mode" : 0,
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 338.0, 249.0, 33.0 ],
"patching_rect" : [ 287.0, 342.0, 249.0, 33.0 ],
"proportion" : 0.39,
"rounded" : 0,
"style" : ""
Expand All @@ -133,7 +167,7 @@
"maxclass" : "comment",
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 518.0, 249.0, 33.0 ],
"patching_rect" : [ 354.0, 578.0, 182.0, 33.0 ],
"style" : "",
"text" : "NB : This is theoretical, the best choice is to trust your ears.",
"textcolor" : [ 0.30292, 0.30292, 0.30292, 1.0 ],
Expand All @@ -152,7 +186,7 @@
"mode" : 0,
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 518.0, 249.0, 33.0 ],
"patching_rect" : [ 354.0, 578.0, 182.0, 33.0 ],
"proportion" : 0.39,
"rounded" : 0,
"style" : ""
Expand All @@ -164,13 +198,13 @@
"fontname" : "Arial",
"fontsize" : 12.0,
"id" : "obj-4",
"linecount" : 4,
"linecount" : 2,
"maxclass" : "comment",
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 446.0, 249.0, 60.0 ],
"patching_rect" : [ 287.0, 491.0, 249.0, 33.0 ],
"style" : "",
"text" : "inPhase optimization could be used when an\naudience is confined to the center of the restitution area or when an audience covers all of the restitution area.",
"text" : "inPhase optimization is used when the audience covers all the circle.",
"textcolor" : [ 0.30292, 0.30292, 0.30292, 1.0 ],
"varname" : "autohelp_top_description[4]"
}
Expand All @@ -181,13 +215,13 @@
"fontname" : "Arial",
"fontsize" : 12.0,
"id" : "obj-3",
"linecount" : 3,
"linecount" : 2,
"maxclass" : "comment",
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 388.0, 249.0, 47.0 ],
"patching_rect" : [ 287.0, 446.5, 249.0, 33.0 ],
"style" : "",
"text" : "maxRe optimization could be used when a listener is ideally placed at the center of the loudspeaker arrangement.",
"text" : "maxRe optimization is used when audience is confined to the center of the circle.",
"textcolor" : [ 0.30292, 0.30292, 0.30292, 1.0 ],
"varname" : "autohelp_top_description[3]"
}
Expand Down Expand Up @@ -301,7 +335,7 @@
"mode" : 0,
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 388.0, 249.0, 47.0 ],
"patching_rect" : [ 287.0, 446.5, 249.0, 33.0 ],
"proportion" : 0.39,
"rounded" : 0,
"style" : ""
Expand Down Expand Up @@ -515,7 +549,7 @@
"appversion" : {
"major" : 7,
"minor" : 0,
"revision" : 3,
"revision" : 4,
"architecture" : "x64",
"modernui" : 1
}
Expand Down Expand Up @@ -658,13 +692,6 @@
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 462.0, 158.0, 74.0, 21.0 ],
"saved_object_attributes" : {
"nhcolor" : [ 0.0, 0.0, 1.0, 1.0 ],
"phcolor" : [ 1.0, 0.0, 0.0, 1.0 ],
"planecolor" : [ 1.0, 1.0, 1.0, 1.0 ],
"zhcolor" : [ 0.2, 0.2, 0.2, 1.0 ]
}
,
"style" : "",
"text" : "hoa.connect"
}
Expand Down Expand Up @@ -733,7 +760,7 @@
"mode" : 0,
"numinlets" : 1,
"numoutlets" : 0,
"patching_rect" : [ 287.0, 446.0, 249.0, 60.0 ],
"patching_rect" : [ 287.0, 491.0, 249.0, 33.0 ],
"proportion" : 0.39,
"rounded" : 0,
"style" : ""
Expand Down Expand Up @@ -1512,7 +1539,7 @@
"appversion" : {
"major" : 7,
"minor" : 0,
"revision" : 3,
"revision" : 4,
"architecture" : "x64",
"modernui" : 1
}
Expand Down Expand Up @@ -1598,8 +1625,8 @@
],
"lines" : [ ],
"parameters" : {
"obj-35::obj-30::obj-21::obj-6" : [ "live.tab[3]", "live.tab[1]", 0 ],
"obj-35::obj-30::obj-35" : [ "[5]", "Level", 0 ]
"obj-35::obj-30::obj-35" : [ "[5]", "Level", 0 ],
"obj-35::obj-30::obj-21::obj-6" : [ "live.tab[3]", "live.tab[1]", 0 ]
}
,
"dependency_cache" : [ {
Expand Down Expand Up @@ -1635,21 +1662,18 @@
, {
"name" : "hoa.helpheader.maxpat",
"bootpath" : "~/Documents/programmation/CICM/sourceTree/HoaLibrary-Max/Package/HoaLibrary/misc/others",
"patcherrelativepath" : "../../misc/others",
"type" : "JSON",
"implicit" : 1
}
, {
"name" : "hoa.2d.scope~.svg",
"bootpath" : "~/Documents/programmation/CICM/sourceTree/HoaLibrary-Max/Package/HoaLibrary/misc/object-palettes",
"patcherrelativepath" : "../../misc/object-palettes",
"type" : "svg ",
"implicit" : 1
}
, {
"name" : "hoa.helpcredit.maxpat",
"bootpath" : "~/Documents/programmation/CICM/sourceTree/HoaLibrary-Max/Package/HoaLibrary/misc/others",
"patcherrelativepath" : "../../misc/others",
"type" : "JSON",
"implicit" : 1
}
Expand Down

0 comments on commit 7876c20

Please sign in to comment.