1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gsk.CrossFadeNode; 26 27 private import glib.ConstructionException; 28 private import gobject.ObjectG; 29 private import gsk.RenderNode; 30 private import gsk.c.functions; 31 public import gsk.c.types; 32 33 34 /** 35 * A render node cross fading between two child nodes. 36 */ 37 public class CrossFadeNode : RenderNode 38 { 39 /** the main Gtk struct */ 40 protected GskCrossFadeNode* gskCrossFadeNode; 41 42 /** Get the main Gtk struct */ 43 public GskCrossFadeNode* getCrossFadeNodeStruct(bool transferOwnership = false) 44 { 45 if (transferOwnership) 46 ownedRef = false; 47 return gskCrossFadeNode; 48 } 49 50 /** the main Gtk struct as a void* */ 51 protected override void* getStruct() 52 { 53 return cast(void*)gskCrossFadeNode; 54 } 55 56 /** 57 * Sets our main struct and passes it to the parent class. 58 */ 59 public this (GskCrossFadeNode* gskCrossFadeNode, bool ownedRef = false) 60 { 61 this.gskCrossFadeNode = gskCrossFadeNode; 62 super(cast(GskRenderNode*)gskCrossFadeNode, ownedRef); 63 } 64 65 66 /** */ 67 public static GType getType() 68 { 69 return gsk_cross_fade_node_get_type(); 70 } 71 72 /** 73 * Creates a `GskRenderNode` that will do a cross-fade between @start and @end. 74 * 75 * Params: 76 * start = The start node to be drawn 77 * end = The node to be cross_fadeed onto the @start node 78 * progress = How far the fade has progressed from start to end. The value will 79 * be clamped to the range [0 ... 1] 80 * 81 * Returns: A new `GskRenderNode` 82 * 83 * Throws: ConstructionException GTK+ fails to create the object. 84 */ 85 public this(RenderNode start, RenderNode end, float progress) 86 { 87 auto __p = gsk_cross_fade_node_new((start is null) ? null : start.getRenderNodeStruct(), (end is null) ? null : end.getRenderNodeStruct(), progress); 88 89 if(__p is null) 90 { 91 throw new ConstructionException("null returned by new"); 92 } 93 94 this(cast(GskCrossFadeNode*) __p); 95 } 96 97 /** 98 * Retrieves the child `GskRenderNode` at the end of the cross-fade. 99 * 100 * Returns: a `GskRenderNode` 101 */ 102 public RenderNode getEndChild() 103 { 104 auto __p = gsk_cross_fade_node_get_end_child(cast(GskRenderNode*)gskCrossFadeNode); 105 106 if(__p is null) 107 { 108 return null; 109 } 110 111 return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p); 112 } 113 114 /** 115 * Retrieves the progress value of the cross fade. 116 * 117 * Returns: the progress value, between 0 and 1 118 */ 119 public float getProgress() 120 { 121 return gsk_cross_fade_node_get_progress(cast(GskRenderNode*)gskCrossFadeNode); 122 } 123 124 /** 125 * Retrieves the child `GskRenderNode` at the beginning of the cross-fade. 126 * 127 * Returns: a `GskRenderNode` 128 */ 129 public RenderNode getStartChild() 130 { 131 auto __p = gsk_cross_fade_node_get_start_child(cast(GskRenderNode*)gskCrossFadeNode); 132 133 if(__p is null) 134 { 135 return null; 136 } 137 138 return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p); 139 } 140 }