2016-01-30 07:48:16 -05:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "UTF-8" >
2016-01-31 10:55:04 -05:00
< title > SymbolDefinition< / title >
2016-01-30 07:48:16 -05:00
< base target = "class-frame" >
< link href = "../assets/css/docs.css" rel = "stylesheet" type = "text/css" >
< script src = "../assets/js/paper.js" > < / script >
< script src = "../assets/js/jquery.js" > < / script >
< script src = "../assets/js/codemirror.js" > < / script >
< script src = "../assets/js/docs.js" > < / script >
< / head >
< body >
< article class = "reference" >
< div class = "reference-class" >
2016-01-31 10:55:04 -05:00
< h1 > SymbolDefinition< / h1 >
2016-01-30 07:48:16 -05:00
< p > Symbols allow you to place multiple instances of an item in your project. This can save memory, since all instances of a symbol simply refer to the original item and it can speed up moving around complex objects, since internal properties such as segment lists and gradient positions don’ t need to be updated with every transformation.< / p >
< / div >
<!-- =============================== constructors ========================== -->
< div class = "reference-members" >
< h2 > Constructors< / h2 >
2016-01-31 10:55:04 -05:00
< div id = "symboldefinition-item" class = "member" >
2016-01-30 07:48:16 -05:00
< div class = "member-link" >
2016-01-31 10:55:04 -05:00
< a name = "symboldefinition-item" href = "#symboldefinition-item" > < tt > < b > SymbolDefinition< / b > (item[, dontCenter])< / tt > < / a >
2016-01-30 07:48:16 -05:00
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
2016-01-31 10:55:04 -05:00
< p > Creates a Symbol definition.< / p >
2016-01-30 07:48:16 -05:00
< ul class = "member-list" >
< h4 > Parameters:< / h4 >
< li >
< tt > item:< / tt >
< a href = "../classes/Item.html" > < tt > Item< / tt > < / a >
2016-01-31 10:55:04 -05:00
— the source item which is removed from the scene graph and becomes the symbol’ s definition.
2016-01-30 07:48:16 -05:00
< / li >
< li >
< tt > dontCenter:< / tt >
< tt > Boolean< / tt >
— optional, default: < tt > false< / tt >
< / li >
< / ul >
< ul class = "member-list" >
< h4 > Returns:< / h4 >
< li >
2016-01-31 10:55:04 -05:00
< tt > < a href = "../classes/SymbolDefinition.html" > < tt > SymbolDefinition< / tt > < / a > < / tt >
2016-01-30 07:48:16 -05:00
< / li >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / ul >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< h4 > Example:< span class = "description" > Placing 100 instances of a symbol:< / span > < / h4 >
< div class = "paperscript split" >
< div class = "buttons" >
< div class = "button run" > Run< / div >
< / div >
< script type = "text/paperscript" canvas = "canvas-0" >
var path = new Path.Star(new Point(0, 0), 6, 5, 13);
path.style = {
fillColor: 'white',
strokeColor: 'black'
};
2016-01-31 10:55:04 -05:00
// Create a symbol definition from the path:
var definition = new SymbolDefinition(path);
2016-01-30 07:48:16 -05:00
2016-01-31 10:55:04 -05:00
// Place 100 instances of the symbol definition:
2016-01-30 07:48:16 -05:00
for (var i = 0; i < 100 ; i + + ) {
2016-01-31 10:55:04 -05:00
// Place an instance of the symbol definition in the project:
var instance = definition.place();
2016-01-30 07:48:16 -05:00
// Move the instance to a random position within the view:
instance.position = Point.random() * view.size;
// Rotate the instance by a random amount between
// 0 and 360 degrees:
instance.rotate(Math.random() * 360);
// Scale the instance between 0.25 and 1:
instance.scale(0.25 + Math.random() * 0.75);
}
< / script >
< div class = "canvas" > < canvas width = "516" height = "240" id = "canvas-0" > < / canvas > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
<!-- ================================ properties =========================== -->
< div class = "reference-members" >
< h2 > Properties< / h2 >
< div id = "project" class = "member" >
< div class = "member-link" >
< a name = "project" href = "#project" > < tt > < b > project< / b > < / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > The project that this symbol belongs to.< / p >
< p > Read only.< / p >
< ul class = "member-list" >
< h4 > Type:< / h4 >
< li >
< a href = "../classes/Project.html" > < tt > Project< / tt > < / a >
< / li >
< / ul >
< / div >
< / div >
< / div >
2016-01-31 10:55:04 -05:00
< div id = "item" class = "member" >
2016-01-30 07:48:16 -05:00
< div class = "member-link" >
2016-01-31 10:55:04 -05:00
< a name = "item" href = "#item" > < tt > < b > item< / b > < / tt > < / a >
2016-01-30 07:48:16 -05:00
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
2016-01-31 10:55:04 -05:00
< p > The item used as the symbol’ s definition.< / p >
2016-01-30 07:48:16 -05:00
< ul class = "member-list" >
< h4 > Type:< / h4 >
< li >
< a href = "../classes/Item.html" > < tt > Item< / tt > < / a >
< / li >
< / ul >
< / div >
< / div >
< / div >
< / div >
<!-- ============================== methods ================================ -->
< div class = "reference-members" >
< h2 > Methods< / h2 >
< div id = "place" class = "member" >
< div class = "member-link" >
< a name = "place" href = "#place" > < tt > < b > place< / b > ([position])< / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > Places in instance of the symbol in the project.< / p >
< ul class = "member-list" >
< h4 > Parameters:< / h4 >
< li >
< tt > position:< / tt >
< a href = "../classes/Point.html" > < tt > Point< / tt > < / a >
— the position of the placed symbol
— optional
< / li >
< / ul >
< ul class = "member-list" >
< h4 > Returns:< / h4 >
< li >
2016-01-31 10:55:04 -05:00
< tt > < a href = "../classes/SymbolItem.html" > < tt > SymbolItem< / tt > < / a > < / tt >
2016-01-30 07:48:16 -05:00
< / li >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / ul >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / div >
< / div >
< / div >
< div id = "clone" class = "member" >
< div class = "member-link" >
< a name = "clone" href = "#clone" > < tt > < b > clone< / b > ()< / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > Returns a copy of the symbol.< / p >
< ul class = "member-list" >
< h4 > Returns:< / h4 >
< li >
2023-10-30 15:39:12 -04:00
< tt > < a href = "../classes/SymbolDefinition.html" > < tt > SymbolDefinition< / tt > < / a > < / tt >
2016-01-30 07:48:16 -05:00
< / li >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / ul >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / div >
< / div >
< / div >
< div id = "equals-symbol" class = "member" >
< div class = "member-link" >
< a name = "equals-symbol" href = "#equals-symbol" > < tt > < b > equals< / b > (symbol)< / tt > < / a >
< / div >
< div class = "member-description hidden" >
< div class = "member-text" >
< p > Checks whether the symbol’ s definition is equal to the supplied symbol.< / p >
< ul class = "member-list" >
< h4 > Parameters:< / h4 >
< li >
< tt > symbol:< / tt >
2023-10-30 15:39:12 -04:00
< a href = "../classes/SymbolDefinition.html" > < tt > SymbolDefinition< / tt > < / a >
2016-01-30 07:48:16 -05:00
< / li >
< / ul >
< ul class = "member-list" >
< h4 > Returns:< / h4 >
< li >
< tt > < tt > Boolean< / tt > < / tt > — < tt > true< / tt > if they are equal, < tt > false< / tt > otherwise
< / li >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / ul >
2017-01-11 09:08:06 -05:00
2016-01-30 07:48:16 -05:00
< / div >
< / div >
< / div >
< / div >
<!-- =========================== copyright notice ========================== -->
< p class = "footer" >
2023-10-30 15:39:12 -04:00
Paper.js v0.12.7< br >
2024-02-21 16:05:01 -05:00
Copyright © 2011—2024 < a href = "http://www.lehni.org" target = "_blank" > Jü rg Lehni< / a > & < a href = "http://www.jonathanpuckey.com" target = "_blank" > Jonathan Puckey< / a > . All Rights Reserved.< / p >
2016-01-30 07:48:16 -05:00
< div class = "content-end" > < / div >
< / article >
< / body >
