# Unity [C++] custom iterators

## Recommended Posts

I have a 3D array representing Z, Y and X like
vector< vector< vector<T> > > myArray
where T is some type. Now if I form an iterator
vector<T>::iterator xIter
xIter = myArray[z][y].begin();
I can loop over the x dimension of the array. Now if I have a function that iterates over x performing some action (say, gaussian blur in 1D) I'd define it something like
doBlur(vector<T>::iterator xIterBegin, vector<T>::iterator xIterEnd);
which would in place blur along a line along the x-axis. Based on responses to this thread, I can define a templated function to take *any* iterator. So, with all this in mind, I can see how to write my 1D blur function using templates, allowing me to perform a blur with multiple calls with different iterators, as long as I can pass in iterators that iterate over the x, y, z coordinates as appropriate. What I can't see is what these iterators should be. Thinking about an iterator for the y axis, perhaps something like
vector< vector<T> >::iterator yIter
yIter = myArray[z].begin();
but this doesn't quite work as dereferencing the iterator gives me vector<T> not T, as I'd like. How do I write a custom iterator to give me this functionality? Do I have to write a custom iterator or is there a simpler, clever, way to do it? Many TIA

##### Share on other sites
Something you seem to have overlooked when considering y-axis iteration is that there are many 'columns' down which you could iterate.
What you're trying to do is actually disregarde the 'column-identifier', which turns out to be the x-component, and this just isn't practical.

Side note:
You might wonder why you can disregard the y (or even z) components for iterating along the x-axis, the answer is that this largely down to the way that you've set up your nested vectors such that the x-axis vector is the vector that actually contains the data.

Well it turns out you have a few ways to solve this.

One way, which isn't entirely unreasonable I suppose, is to write custom iterators. This might make (more) sense if you wrapped those nested vectors into a new container class, call it CubeArray for example, then you can have a custom 3D iterator that you can access like normal: CubeArray<T>::iterator.

Writing iterators isn't hard, you just need to provide some technique to... well... iterate. Depending on the function that you provide your iterator can be a forwards iterator, backwards iterator, random access iterator etc.

If you're interested in writing STL compliant iterators then you need to adhere to their interface requirements. For example here you can find the details of a bi-directional iterator, if you provide a class with those functions then it's a fully compliant iterator.

However,
Other solutions certainly do exist; one way might be to condense your container down into a single vector:

vector<T> myArray

Note: You might actually gain some efficiency from a single vector, but that's not why I'm suggesting it.

You can still pretend this is a 3-dimensional array if you know the width, height and depth, although actually you don't need the depth for accessing elements:

myArray[(z * height + y) * width + x]

This now means that all mutable iterators will be of type vector<T>::iterator.

In order to allow the doBlur function to do its job it needs to be augmented with an offset argument; it must now also require that its iterators be random-access iterators (vector iterators are random access, so it's fine).

This offset argument (occasionally called the 'pitch', I think) is the offset from one element to the next.
So (if),
the x-axis components are contiguous, it's an offset of: 0,
the y-axis components are width distance apart, it's an offset of: width,
the z-axis components are width * height distance apart, it's an offset of: width * height.

To see this in action:

template <class RandomAccessIter>
void doBlur(RandomAccessIter xIterBegin, RandomAccessIter xIterEnd, int offset);

vector<T>::iterator yIterBegin = myArray.begin() + ((z1 * height + y1) * width + x1);
vector<T>::iterator yIterEnd = myArray.begin() + ((z2 * height + y2) * width + x2);
int offset = width;
doBlur(yIterBegin, yIterEnd, offset);

It would probably do to write a utility function to return the iterator at a given x, y, z position.

##### Share on other sites
Yes, there is a simpler way: use a more powerful (and more efficient) representation of the 3D array - boost::multi_array.

It holds things in a single allocated space (as far as I can tell from the documentation), and makes sure the array is "rectangular". Basically, it computes an index based on the dimensions and bounds of the array and indexes into a single vector. That avoids wasting lots of space (unused vector reserve capacity; redundant "per-row" vector object bookkeeping data).

It also provides a way to create "views" of parts of the array, in each dimension.

typedef boost::multi_array<Thing, 3> grid;typedef typename grid::array_view<1>::type column;grid myArray(boost::extents[5][5][5]); // or whatever size you wantedtypedef grid::index_range range;grid::index_gen indices;// Take 1D "core samples" in each direction, going through the middle of the cube.column x22 = myArray[indices[range(0, 5)][2][2]];column y22 = myArray[indices[2][range(0, 5)][2]];column z22 = myArray[indices[2][2][range(0, 5)]];// assuming we have template <typename Iterator> void blur(Iterator begin, Iterator end), blur each sample:blur(x22.begin(), x22.end());blur(y22.begin(), y22.end());blur(z22.begin(), z22.end());

Reference.

##### Share on other sites
Of course boost::multi_array essentially does the same thing that I suggested, except it wraps everything up for you in a nice clean interface. [smile]

I'm not a huge user of the boost libraries so I tend to forget to recommend it's components. I'd suggest you go for the boost solution, unless, like me, you're prone to reinventing the wheel.

##### Share on other sites
I've done the "flatten 3D to 1D" thing many times, usually with bog standard arrays rather than vectors but the same thing. I'm not sure about the boost::multi_array being able to do exactly what I want but that's my fault for not being clear enough in my original post. Although the blur example describes my problem it also implied a "rectangular" array; this isn't the case. The number of elements in each vector can (and is) different depending on the dimensional coordinate: the first 2 'outer' vectors are rectangular but the last, innermost, vector can change in length.

Can boost::multi_array be formed to hold vector<T> objects with the
typedef typename grid::array_view<1>::type column
acting as my outer iterator? I think it should but am not sure - I've never used boost before. Also, what is the speed likely to be like compared to a custom iterator?

I'll also have a look at writing my own iterator as an intellectual exercise :)

Thanks for you help.

##### Share on other sites
Quote:
 Original post by coordzI've done the "flatten 3D to 1D" thing many times, usually with bog standard arrays rather than vectors but the same thing. I'm not sure about the boost::multi_array being able to do exactly what I want but that's my fault for not being clear enough in my original post. Although the blur example describes my problem it also implied a "rectangular" array; this isn't the case. The number of elements in each vector can (and is) different depending on the dimensional coordinate: the first 2 'outer' vectors are rectangular but the last, innermost, vector can change in length.

So, make a boost::multi_array<2, std::vector<T> >. No problem.

Except... what does it mean to iterate over Y and Z dimensions, then? Say I want to iterate over X = 3, Z = 1... what if I hit a vector (indexed by X) that doesn't have enough elements?

## Create an account

Register a new account

• ## Partner Spotlight

• ### Forum Statistics

• Total Topics
627682
• Total Posts
2978615
• ### Similar Content

• By trjh2k2
I've never really been a "Unity guy", since all of my game-dev learning happened in C++, and in other engines, but I recently discovered the "complete projects" section in the asset store.  It's full up on projects you can buy that are billed as "ready to customize and release", with full ad integration.  Some of them claim to be for educational purposes, but why would you include a complete, polished, full featured game with ads as an educational example?
This leads me to the question of why this goes by unchallenged?  Does Unity and the environment of the Unity Store actively encourage this style of game development?  Is the problem of asset flipping our own fault?  I don't mean this as a "we should make Unity shut this down" kind of thread, but rather just to examine whether or not the environment of being able to just buy whole games or pieces of games is something that damages the industry.  I get why Unity would allow it, and I'm sure it's a working business model for some people- and maybe some people DO actually just use these to learn from, but I'm not that naive as to think that there aren't people who recognize this as one of the shortest paths to putting a game on the market so they can cash in.
Thoughts?
• By StefanJo
Hi everyone!
I have just released a project called Line Driving to the Unity Asset Store.
Line Driving is complete project ready for release for both Mobile and PC.
It is a game where you have to draw your own road for a car using mouse controls or touch input.
Features:
1.Simple to understand,detailed commented scripts
2.Well-written documentation
5.Easy to customize
and much more…
Support email: sjovanovic0831@gmail.com

• Got the UI Inventory screen working now.
Fully keyboard and mouse driven, this is where you manage all your items split up into separate 'tabs'.
This is the 'Fossil' management area.

• Hey, I'm looking for some people that can help me with a game that I'm making that is a 3d platformer.
I mostly need someone for character design and animation,  I can do some coding but if you can do coding as well you're still welcome because I'm still not the greatest at coding just yet.
if you need to contact me add me on discord @ Kurupted#1206

• Hi,guys.I m working on a Fantasy RPG.Currently i m work alone on the project.I really need someone can make UI stuff.If someone can handle it please feel free to contact me on email: 270514974@libero.it.
Thank you guys and sorry for my english.

• 13
• 12
• 10
• 12
• 22