Max::hoa.3d.wider~ refs

Max/Max2D/HoaWider/hoa.2d.wider~.cpp

@@ -62,7 +62,7 @@ int C74_EXPORT main(void)
     hoa_initclass(c, (method)hoa_getinfos);
 
 	// @method signal @digest Array of circular harmonic signals to be processed, widening value.
-	// @description Array of circular harmonic signals to be processes. Set the widening value in the last inlet at signal rate. The widening value is clipped between 0. and 1.
+	// @description Array of circular harmonic signals to be processed. Set the widening value in the last inlet at signal rate. The widening value is clipped between 0. and 1.
 	class_addmethod(c, (method)hoa_wider_dsp64,		"dsp64",	A_CANT, 0);
 	class_addmethod(c, (method)hoa_wider_assist,	"assist",	A_CANT, 0);
 

Max/Max3D/HoaWider/hoa.3d.wider~.cpp

@@ -1,8 +1,30 @@
 /*
-// Copyright (c) 2012-2014 Eliott Paris, Julien Colafrancesco & Pierre Guillot, CICM, Universite Paris 8.
-// For information on usage and redistribution, and for a DISCLAIMER OF ALL
-// WARRANTIES, see the file, "LICENSE.txt," in this distribution.
-*/
+ // Copyright (c) 2012-2014 Eliott Paris, Julien Colafrancesco & Pierre Guillot, CICM, Universite Paris 8.
+ // For information on usage and redistribution, and for a DISCLAIMER OF ALL
+ // WARRANTIES, see the file, "LICENSE.txt," in this distribution.
+ */
+
+/**
+ @file      hoa.3d.wider~.cpp
+ @name      hoa.3d.wider~
+ @realname  hoa.3d.wider~
+ @type      object
+ @module    hoa
+ @author    Julien Colafrancesco, Pierre Guillot, Eliott Paris.
+ 
+ @digest
+ A fractional ambisonic orders simulator for 2d
+ 
+ @description
+ <o>hoa.3d.wider~</o> can be used to wide the diffusion of a localised sound. The order depending signals are weighted and appear in a logarithmic way to have linear changes.
+ 
+ @discussion
+ <o>hoa.3d.wider~</o> can be used to wide the diffusion of a localised sound. The order depending signals are weighted and appear in a logarithmic way to have linear changes.
+ 
+ @category ambisonics, hoa objects, audio, MSP
+ 
+ @seealso hoa.2d.wider~, hoa.3d.encoder~, hoa.3d.decoder~, hoa.3d.map~, hoa.3d.optim~, hoa.3d.scope~
+ */
 
 #include "../Hoa3D.max.h"
 
@@ -39,8 +61,16 @@ int C74_EXPORT main(void)
 
 	hoa_initclass(c, (method)hoa_getinfos);
 
+	// @method float @digest Set the widening value.
+	// @description Set the widening value in the last inlet at control rate. The widening value is clipped between 0. and 1.
 	class_addmethod(c, (method)hoa_wider_float,		"float",	A_FLOAT, 0);
+
+	// @method int @digest Set the widening value.
+	// @description Set the widening value in the last inlet at control rate. The widening value is clipped between 0. and 1.
 	class_addmethod(c, (method)hoa_wider_int,       "int",		A_LONG, 0);
+
+	// @method signal @digest Array of spherical harmonics signals to be processed, widening value.
+	// @description Array of spherical harmonics signals to be processed. Set the widening value in the last inlet at signal rate. The widening value is clipped between 0. and 1.
 	class_addmethod(c, (method)hoa_wider_dsp64,		"dsp64",	A_CANT, 0);
 	class_addmethod(c, (method)hoa_wider_assist,    "assist",	A_CANT, 0);
 
@@ -52,6 +82,9 @@ int C74_EXPORT main(void)
 
 void *hoa_wider_new(t_symbol *s, long argc, t_atom *argv)
 {
+	// @arg 0 @name ambisonic-order @optional 0 @type int @digest The ambisonic order of decomposition
+	// @description First argument is the ambisonic order of decomposition.
+
 	t_hoa_wider *x = NULL;
 	int	order = 1;
     x = (t_hoa_wider *)object_alloc(hoa_wider_class);

Max/Package/HoaLibrary/docs/refpages/hoa-ref/_c74_contents.xml

@@ -18,6 +18,7 @@
 <refpage name='hoa.3d.encoder~.maxref.xml'/>
 <refpage name='hoa.3d.map~.maxref.xml'/>
 <refpage name='hoa.3d.optim~.maxref.xml'/>
+<refpage name='hoa.3d.wider~.maxref.xml'/>
 <refpage name='c.convolve~.maxref.xml'/>
 <refpage name='c.freeverb~.maxref.xml'/>
 <refpage name='hoa.connect.maxref.xml'/>

Max/Package/HoaLibrary/docs/refpages/hoa-ref/hoa.2d.wider~.maxref.xml

@@ -60,7 +60,7 @@
 				Array of circular harmonic signals to be processed, widening value.
 			</digest>
 			<description>
-				Array of circular harmonic signals to be processes. Set the widening value in the last inlet at signal rate. The widening value is clipped between 0. and 1.
+				Array of circular harmonic signals to be processed. Set the widening value in the last inlet at signal rate. The widening value is clipped between 0. and 1.
 			</description>
 		</method>
 	</methodlist>

Max/Package/HoaLibrary/docs/refpages/hoa-ref/hoa.3d.wider~.maxref.xml

@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>
+
+<!--This file has been automatically generated by Doctor Max. DO NOT EDIT THIS FILE DIRECTLY.-->
+
+<c74object name="hoa.3d.wider~" module="hoa">
+
+	<digest>
+		A fractional ambisonic orders simulator for 2d
+	</digest>
+
+	<description>
+		<o>hoa.3d.wider~</o> can be used to wide the diffusion of a localised sound. The order depending signals are weighted and appear in a logarithmic way to have linear changes.
+	</description>
+
+	<!--METADATA-->
+	<metadatalist>
+		<metadata name="author">Julien Colafrancesco, Pierre Guillot, Eliott Paris.</metadata>
+		<metadata name="tag">ambisonics</metadata>
+		<metadata name="tag">hoa objects</metadata>
+		<metadata name="tag">audio</metadata>
+		<metadata name="tag">MSP</metadata>
+	</metadatalist>
+
+	<!--ARGUMENTS-->
+	<objarglist>
+		<objarg name="ambisonic-order" optional="0" type="int">
+			<digest>
+				The ambisonic order of decomposition
+			</digest>
+			<description>
+				First argument is the ambisonic order of decomposition.
+			</description>
+		</objarg>
+	</objarglist>
+
+	<!--MESSAGES-->
+	<methodlist>
+		<method name="float">
+			<arglist />
+			<digest>
+				Set the widening value.
+			</digest>
+			<description>
+				Set the widening value in the last inlet at control rate. The widening value is clipped between 0. and 1.
+			</description>
+		</method>
+		<method name="int">
+			<arglist />
+			<digest>
+				Set the widening value.
+			</digest>
+			<description>
+				Set the widening value in the last inlet at control rate. The widening value is clipped between 0. and 1.
+			</description>
+		</method>
+		<method name="signal">
+			<arglist />
+			<digest>
+				Array of spherical harmonics signals to be processed, widening value.
+			</digest>
+			<description>
+				Array of spherical harmonics signals to be processed. Set the widening value in the last inlet at signal rate. The widening value is clipped between 0. and 1.
+			</description>
+		</method>
+	</methodlist>
+
+	<!--ATTRIBUTES-->
+	<attributelist>
+	</attributelist>
+
+	<!--DISCUSSION-->
+	<discussion>
+		<o>hoa.3d.wider~</o> can be used to wide the diffusion of a localised sound. The order depending signals are weighted and appear in a logarithmic way to have linear changes.
+	</discussion>
+
+	<!--SEEALSO-->
+	<seealsolist>
+		<seealso name="hoa.2d.wider~" />
+		<seealso name="hoa.3d.encoder~" />
+		<seealso name="hoa.3d.decoder~" />
+		<seealso name="hoa.3d.map~" />
+		<seealso name="hoa.3d.optim~" />
+		<seealso name="hoa.3d.scope~" />
+	</seealsolist>
+
+	<misc name = "Discussion">
+		<entry name ="More details">
+			<description>
+		<o>hoa.3d.wider~</o> can be used to wide the diffusion of a localised sound. The order depending signals are weighted and appear in a logarithmic way to have linear changes.
+			</description>
+		</entry>
+		<entry name ="Keywords">
+			<description>
+			</description>
+		</entry>
+	</misc>
+
+</c74object>

Max/Package/HoaLibrary/docs/refpages/init/hoa-objectlist.txt

@@ -16,6 +16,7 @@ max oblist "hoa objects" hoa.3d.decoder~;
 max oblist "hoa objects" hoa.3d.encoder~;
 max oblist "hoa objects" hoa.3d.map~;
 max oblist "hoa objects" hoa.3d.optim~;
+max oblist "hoa objects" hoa.3d.wider~;
 max oblist "hoa objects" c.convolve~;
 max oblist "hoa objects" c.freeverb~;
 max oblist "hoa objects" hoa.connect;

Max/Package/HoaLibrary/externals/Hoa3d/hoa.3d.wider~.mxo/Contents/Resources/MaxHoa3D.xcconfig

@@ -19,8 +19,8 @@ C74SUPPORT = $(SRCROOT)/../../../ThirdParty/Max/c74support
 HEADER_SEARCH_PATHS = "$(C74SUPPORT)/max-includes" "$(C74SUPPORT)/msp-includes" "$(C74SUPPORT)/jit-includes"
 FRAMEWORK_SEARCH_PATHS = "$(C74SUPPORT)/max-includes" "$(C74SUPPORT)/msp-includes" "$(C74SUPPORT)/jit-includes"
 //DSTROOT = $(SRCROOT)/../../buildsCommon
-MAXPACKAGE = $(SRCROOT)/../../../_prerelease/max-package
-DSTROOT = $(MAXPACKAGE)/externals
+MAXPACKAGE = $(SRCROOT)/../../Package/HoaLibrary
+DSTROOT = $(MAXPACKAGE)/externals/Hoa3d
 // (This next path is relative to DSTROOT)
 INSTALL_PATH = /
 

Max/Package/HoaLibrary/help/Hoa3d/hoa.3d.wider~.maxhelp

@@ -167,7 +167,6 @@
 									"numoutlets" : 1,
 									"outlettype" : [ "signal" ],
 									"patching_rect" : [ 275.25, 308.0, 62.0, 19.0 ],
-									"presentation_rect" : [ 457.625, 306.0, 0.0, 0.0 ],
 									"text" : "hoa.pi~ 2."
 								}
 
@@ -182,7 +181,6 @@
 									"numoutlets" : 1,
 									"outlettype" : [ "signal" ],
 									"patching_rect" : [ 318.25, 278.0, 72.0, 19.0 ],
-									"presentation_rect" : [ 500.625, 276.0, 0.0, 0.0 ],
 									"text" : "phasor~ 0.1"
 								}
 
@@ -197,7 +195,6 @@
 									"numoutlets" : 4,
 									"outlettype" : [ "signal", "signal", "signal", "signal" ],
 									"patching_rect" : [ 37.0, 405.25, 336.666656, 19.0 ],
-									"presentation_rect" : [ 747.0, 355.25, 0.0, 0.0 ],
 									"text" : "hoa.3d.wider~ 1"
 								}
 
@@ -226,7 +223,7 @@
 									"maxclass" : "comment",
 									"numinlets" : 1,
 									"numoutlets" : 0,
-									"patching_rect" : [ 199.125, 220.0, 104.0, 20.0 ],
+									"patching_rect" : [ 199.125, 220.0, 107.0, 20.0 ],
 									"text" : "Azimuth (0 -  2*π) ",
 									"textcolor" : [ 0.30292, 0.30292, 0.30292, 1.0 ],
 									"varname" : "autohelp_top_description[4]"
@@ -382,6 +379,10 @@
 									"numoutlets" : 8,
 									"outlettype" : [ "signal", "signal", "signal", "signal", "signal", "signal", "signal", "signal" ],
 									"patching_rect" : [ 37.0, 561.0, 336.666656, 19.0 ],
+									"saved_object_attributes" : 									{
+										"mode" : "ambisonic"
+									}
+,
 									"text" : "hoa.3d.decoder~ 1 8"
 								}
 

Max/Package/HoaLibrary/interfaces/hoa-obj-qlookup.json

@@ -191,6 +191,16 @@
       "MSP"
     ]
   },
+  "hoa.3d.wider~": {
+    "digest": "A fractional ambisonic orders simulator for 2d",
+    "module": "hoa",
+    "category": [
+      "ambisonics",
+      "hoa objects",
+      "audio",
+      "MSP"
+    ]
+  },
   "c.convolve~": {
     "digest": "A zero latency convolution reverberation processor",
     "module": "hoa",