Skip to content

parametric-svg/tutorial

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 

Repository files navigation

 

Creating a parametric SVG

There are many ways to create a parametric.svg graphic. If you’re a designer or office person, you’d probably like to draw your things first and attach the parametric stuff later on. You’re in the right place – read on! If you’re more of a coder and want to hand-craft your SVG markup, you can skip right over to our online editor.

You can make a parametric drawing in any SVG editor. There’s a fabulous free open-source one called Inkscape – that’s what we’ll be using in this tutorial. Head over to download, install and start Inkscape. Come back when it’s up and running. We’ll still be here when you come!


Congratulations! Here’s what Inkscape v0.91 greets me with on a Linux machine. You probably see a similar window:

Inkscape greets you

If you’ve ever fiddled with Adobe Illustrator, Corel Draw or even Microsoft Paint, I bet you feel right at home. Creating drawings in Inkscape is really easy.

Off we go then! Let’s start with something simple – we don’t want to make our first drawing too complicated. A circle is a good start. Just make sure you hold down CTRL while drawing – otherwise you’ll end up with an egg-like shape.

Drawing a circle

Well done! Our circle is a plain static SVG element. Let’s make its radius parametric! Inkscape ships with an XML editor – the perfect tool to get the job done. Let’s select the circle and pick the tool Edit → XML Editor… from the top menu.

The XML editor

💡

You can add, edit and remove parametric attributes right inside Inkscape using the built-in XML Editor.

We’re greeted by a window split in two parts. On the left side there is a tree-like structure listing all elements in our drawing. On the right there are attributes of our circle. That’s what we’re interested in!

Under the list of attributes we have two input fields – one for setting the name of an attribute, the other for setting its value.

Right – let’s get our job done. We wanted to make the radius of our circle parametric. To do that let’s select the attribute r in the right pane – and change its name to parametric:r in the input field below.

A parametric attribute

💡

Whenever you want to make an attribute parametric, just add the namespace prefix parametric: to it.

That’s our first parametric attribute! Put something like 3 * (a + 50) in the field below. Our regular r attribute could only have a static value like 157.7027 – but in our parametric:r we use any mathematical expression.

💡

The value of a parametric attribute can be virtually any mathematical expression. It can also contain variables and strings.

Now comes the big moment. Click the button Set or hit CTRL + ENTER on your keyboard to set the attribute! Hold your breath, and—

nothing happened?

No worries. Inkscape doesn’t understand parametric attributes yet – it’s quite a new idea. In the next section we’ll learn how to use a web-based editor to pass variables to our parametric graphic and render the thing.

You may have noticed that by adding the parametric: prefix we created a new attribute. The original r attribute we had selected stayed how it was – Inkscape didn’t replace it. We wouldn’t want that – the plain old r attribute is our fallback value. It will be used by Inkscape and other SVG viewers which don’t understand the parametric.svg format.

💡

Any parametric attribute should have a static fallback – an attribute without the parametric: prefix.

If you feel like it, you can set other parametric attributes on the circle. How about setting parametric:style to `stroke: charcoal; stroke-width: ${2 * 3}`? Don’t worry if you don’t know exactly what it means. You can read up on our specs later.

There’s one more thing we need to do before we close Inkscape. The parametric: prefixes we’ve been talking about should belong to an XML namespace. To make sure our file will open in every SVG viewer, we need to declare the namespace upfront. Click the topmost <svg:svg> element on the left side of the XML editor (it might as well be called <svg>). Then set the attribute xmlns:parametric to //parametric-svg.js.org/v1 on it.

The parametric namespace

💡

Remember to set the attribute xmlns:parametric="//parametric-svg.js.org/v1" on the root <svg> element. This way you’ll make sure your drawing opens anywhere.

Double-check you haven’t made a typo in the namespace stuff. Some SVG parsers are really strict beasts – a single mistyped character can confuse them so much that they can no longer open a drawing.

Alright! With all warnings out of the way let’s save our drawing under the name circle.parametric.svg. Pick the flavor “Plain SVG” in the filetype dropdown (or “Optimized SVG” if you’re feeling adventurous). Any flavor of SVG will do – but Inkscape tends to create bloated markup otherwise.

Saving your drawing

💡

Save your parametric drawings with the extension .parametric.svg. This way all tools will handle them as they should.

All is ready. We can now move on to the most exciting part!

 

The online editor

At the time of writing (October 2015) the easiest way to render our .parametric.svg drawing is through a rudimentary online editor hosted on JS Bin. But trust me – it’s not as bad as it looks! Once we’ve got our drawing inside we can play around, tweak our variables and see the results instantly.

Come on, let’s head over to the editor – instructions are inside!

About

parametric.svg for dummies

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages